API - Usage Methods
ETSF Methods
AddEtsfHouseConsignment
Adds a single ETSF House air waybill to an existing consolidation or basic consignment (adding to a Basic will automatically convert the Basic to a Consolidation Master record).
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventoryExtend.xsd |
| Response (success): | True |
| Response (failure): | False. See Error Reporting above |
CreateEtsfConsignment
Method to create ETSF (formerly ERTS) inventory record(s). This method supports both single records and consolidations - with a collection of subordinate house consignment records.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventory.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
CreateEtsfPreArrivalConsignment
Method to create ETSF (formerly ERTS) pre-arrival inventory record(s). This method supports both single records and consolidations - with a collection of subordinate house consignment records.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventory.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
Notes
This method will not allow a flight arrival date to be supplied.
DeleteEtsfConsignment
Method to delete an ETSF (formerly ERTS) inventory record.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventoryIdentifier.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
GetEtsfConsignment
Method to retrieve details of an ETSF (formerly ERTS) inventory record.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventoryIdentifier.xsd |
| Response (success): | EtsfInventoryDetail.xsd |
| Response (failure): | See Error Reporting above |
MaintainEtsfSplitConsignment
Method to create, extend and delete ETSF split consignment records.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfSplitMaintenance.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
Notes
- Splits (splitReferenceNumber) should be created in sequence, starting with '01'.
- When extending or deleting existing split records, details of all existing splits must be included.
- Split references should not be re-used - i.e. if a split has been deleted then it's reference number should not be re-used to create an additional split. Rather the next unused SRF should be used.
UpdateEtsfConsignment
Method to modify/update a single ETSF (formerly ERTS) inventory record.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventoryAmend.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
UpdateEtsfPreArrivalConsignment
Method to modify/update a single ETSF (formerly ERTS) pre-arrival inventory record.
| Payload | Schema / Return value |
|---|---|
| Request: | EtsfInventoryAmend.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |