Remove a QTRACS Place - OMRMVPLC
Remove a QTRACS Place (OMRMVPLC) RI
Required Parameter Group:
| 1 | Place Identifier | Input | Packed(7,0) |
| 2 | Place Alias | Input | Char(10) |
| 3 | Place Name | Input | Char(25) |
| 4 | Place State | Input | Char(2) |
| 5 | Place Country | Input | Char(2) |
| 6 | Return Status | Output | Char(1) |
API Overview:
The Remove a QTRACS Place API (OMRMVPLC) is used to delete a record from the QTRACS Place Database. A place may be specified in one of three ways: by its unique id, by its unique alias, or by the unique combination of its name, state, and country. Associated ETA data, and type counts will be removed as well. This API provides a reliable and easy to use mechanism for external applications to delete place information from the QTRACS Place Database.
Required Parameter Group Details:
(1) Place Identifier
INPUT; PACKED(7,0)
This parameter is optional but when it is left blank, at least one of the following three input fields must contain enough information to derive a valid place identifier.
(2) Place Alias
INPUT; CHAR(10)
This parameter is optional but when included it is used to derive a valid place identifier.
(3) Place Name
INPUT; CHAR(25)
This parameter is optional but when included it is used in conjunction with the place state and country fields to derive a valid place identifier.
(4) Place State
INPUT; CHAR(2)
This parameter is optional but when included it is used in conjunction with the place name and country fields to derive a valid place identifier.
(5) Place Country
INPUT; CHAR(2)
This parameter is optional but when included it is used in conjunction with the place name and state fields to derive a valid place identifier.
(6) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, place has been deleted from the database |
| 1 | Failure, place was not found |
| 2 | Failure, invalid combination of input parameters; cannot derive place identifier |
| A | Failure, API failed when called remotely |