API - Usage Methods
NCTS Methods
Sequoia v1.125
CreateNctsDeclaration
Specifies a partial or complete NCTS declaration to be stored in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | NctsDeclaration.xsd |
| Response (success): | A string representing the Local reference Number |
| Response (failure): | See Error Reporting above |
Notes
This method will create the NCTS 'Movement' record required by Sequoia and store an NCTS declaration against it.
See also SendNctsDeclaration for details of how to transmit an existing NCTS declaration.
Transactions
Transactions are supported by specifying a TransactionId on the request.
Sequoia v1.125
GetNctsDeclarationStatus
Method to retrieve the latest status of an NCTS declaration.
| Payload | Schema / Return value |
|---|---|
| Request: | NctsDeclarationIdentifier.xsd |
| Response (success): | NctsStatus.xsd |
| Response (failure): | See Error Reporting above |
Status One of the following statuses will be returned in a successful response:
- Declaration Created
- Declaration Awaiting Transmission
- Declaration Transmission Failed
- Declaration Transmitted
- Declaration Cancelled
- Declaration Cancellation Requested
- Declaration Cancellation Request Awaiting Transmission
- Declaration Cancellation Request Transmitted
- Declaration Cancellation Request Transmission Failed
- Declaration Rejected
- Declaration Cancellation Refused
- Declaration Acknowledged
- Declaration MRN Allocated
- Declaration Under Control
- Declaration Not Released For Transit
- Declaration Guarantee Not Valid
- Declaration Released For Transit
- Goods Released From Transit
Sequoia v2.6
GetNctsTransitStatus
Method to retrieve the latest status of an NCTS movement.
| Payload | Schema / Return value |
|---|---|
| Request: | NctsTransitStatus.xsd |
| Response (success): | NctsStatus.xsd |
| Response (failure): | See Error Reporting above |
Status One of the following statuses will be returned in a successful response:
- Arrival created
- Arrival Rejected
- Arrival Transmission Failed
- Arrival Transmitted
- Declaration acknowledged
- Declaration Cancellation refused
- Declaration Cancellation request awaiting transmission
- Declaration Cancellation request transmission failed
- Declaration Cancellation request transmitted
- Declaration Cancellation requested
- Declaration Cancelled
- Declaration created
- Declaration Guarantee not valid
- Declaration MRN allocated
- Declaration not released for transit
- Declaration Rejected
- Declaration released for transit
- Declaration Transmission Failed
- Declaration Transmitted
- Declaration under Control
- Goods Released from transit
- Transit Movement Created
- Unloading Information rejected
- Unloading Permission granted
- Unloading Remarks awaiting transmission
- Unloading Remarks created
- Unloading Remarks transmission failed
- Unloading Remarks transmitted
Sequoia v1.125
SendNctsDeclaration
Transmit an existing NCTS declaration identified by LRN (local reference number).
| Payload | Schema / Return value |
|---|---|
| Request: | NctsDeclarationIdentifier.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |