| Operation |
Public
Create Draft eBL () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Submit Original Booking () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Create Booking - 201 OK () : void
|
Details:
|
Notes:
|
Booking Request has been successfully created in the provider system. The status of the Booking Request is now RECEIVED. The consumer is now awaiting provider to process the Booking Request asynchronously.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Create Booking - 202 Succesfully Adapted () : void
|
Details:
|
Notes:
|
Booking Request has been successfully accepted by the provider. The Booking Request does not yet have a bookingStatus - it is not possible to call the GET endPoint until the Booking Request is further processed in provider system. The consumer is now awaiting provider to process the Booking Request asynchronously.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Create Booking - 400 Bad Schema Validation () : void
|
Details:
|
Notes:
|
In case the Booking Request does not schema validate a 400 (Bad Request) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Create Booking - 500 Internal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Create Booking - Default Error () : void
|
Details:
|
Notes:
|
For other errors the error object should be populated with relevant information.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - 200 Successful () : void
|
Details:
|
Notes:
|
The Booking request has been successfully updated in the provider system with one of the following combinations (depending on the use case):<br/><ul>
<li>bookingStatus='PENDING UPDATE' in case the consumer has provided an update to a Booking request and is awaiting the provider to take action</li><li>bookingStatus='PENDING AMENDMENT' and amendedBookingStatus='AMENDMENT RECEIVED' in case the provider has requested an amendment and the consumer has provided an amendment to a Confirmed Booking and is awaiting the provider to take action</li><li>bookingStatus='CONFIRMED' and amendedBookingStatus='AMENDMENT RECEIVED' in case the consumer has provided an amendment to a Confirmed Booking and is awaiting the provider to take action</li></ul><p/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - 202 Succesfully Adapted () : void
|
Details:
|
Notes:
|
The Booking request update has been successfully accepted by the provider. bookingStatus does not change and response payload is empty. Further processing will be done by provider.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - 400 Bad Schema Validation () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - 404 BookingReference Unknown () : void
|
Details:
|
Notes:
|
In case the provider does not know of the bookingReference used in the request (this could be because of a POST request that has not finished processing or simply because the resource does not exist) - it is possible for the provider to reject the requests by returning a 404 (Not Found)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - 409 Reject Incoming Requests/Conflict () : void
|
Details:
|
Notes:
|
In case the provider is processing the Booking request - it is possible for the provider to reject new incomming requests by returning a 409 (Conflict)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - 500 Internal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Update Booking - Default Error () : void
|
Details:
|
Notes:
|
For other errors the error object should be populated with relevant information.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Booking - 200 Successful () : void
|
Details:
|
Notes:
|
Request successful.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Booking - 202 Booking Being Processed () : void
|
Details:
|
Notes:
|
The Booking is currently being processed by the provider. No payload is returned. A new GET request has to be made periodically to check if the provider has finished processing the Booking.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Booking - 404 Not Found () : void
|
Details:
|
Notes:
|
In case the consumer is requesting the Amended Booking by calling:<br/><br/>GET /v2/bookings/{bookingReference}?amendedContent=true<br/><br/>but:<br/><br/><ul>
<li>the Booking has not yet been confirmed</li><li>the Booking has been confirmed but no amendment has yet been provided by the consumer</li><li>the provider has requested for a new amendment (UseCase 6: Request to amend confirmed Booking) in which case the "old update" is no longer accessable.</li></ul>
<br/>a 404 (Not Found) is returned.<br/><br/>A 404 (Not Found) can also be sent in case the provider does not know of the bookingReference used in the request (the resource does not exist)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Booking - 409 Reject Incoming Requests/Conflict () : void
|
Details:
|
Notes:
|
In case the provider is processing the Booking request - it is possible for the provider to reject new incomming requests by returning a 409 (Conflict)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Booking - 500 Internal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Booking - Default Error () : void
|
Details:
|
Notes:
|
Unexpected error.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - 200 Booking Cancelled Successful () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - 202 Booking Cancellation Accepted () : void
|
Details:
|
Notes:
|
Booking cancellation has been accepted.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - 400 Bad Schema Validation () : void
|
Details:
|
Notes:
|
In case the cancel payload does not schema validate a 400 (Bad Request) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - 404 Cancel Amend Booking () : void
|
Details:
|
Notes:
|
In case the consumer is cancelling the Amended Booking by setting:<br/><br/>`amendedBookingStatus='AMENDMENT CANCELLED'`<br/><br/>but:<br/><br/><ul>
<li>the Booking has not yet been confirmed</li><li>the Booking has been confirmed but no amendment has yet been provided by the consumer</li><li>the provider has requested for a new amendment (UseCase 6: Request to amend confirmed Booking) in which case the "old update" is no longer accessable.</li></ul>
<br/>a 404 (Not Found) is returned.<br/><br/>A 404 (Not Found) can also be sent in case the provider does not know of the bookingReference used in the request (the resource does not exist)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - 409 Reject Incoming Requests/Conflict () : void
|
Details:
|
Notes:
|
In case the provider is processing a Booking request - it is possible for the provider to reject the cancellation by returning a 409 (Conflict). This is also to be used in case a cancellation to a Confirmed Booking is done via the carrierBookingRequestReference.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - 500 Intenal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Cancel Booking or Amendment - Default Error () : void
|
Details:
|
Notes:
|
For other errors the error object should be populated with relevant information.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Submit Booking Update () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
=Delay Next Poll () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Request Amendment to Booking () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Submit Shipping Instructions () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Shipping Instructions - Default Error () : void
|
Details:
|
Notes:
|
For other errors the error object should be populated with relevant information<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Shipping Instructions - 201 Successfully Created () : void
|
Details:
|
Notes:
|
The Shipping Instructions has been successfully created in the provider system. The status of the Shipping Instructions is now RECEIVED. The consumer is now awaiting provider to process the Shipping Instructions asynchronously.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Shipping Instructions - 202 Accepted () : void
|
Details:
|
Notes:
|
The Shipping Instructions has been accepted by the provider. The Shipping Instructions does not yet have a shippingInstructionsStatus - it is not possible to call the GET endPoint until the Shipping Instructions is further processed in provider system. The consumer is now awaiting provider to process the Shipping Instructions asynchronously.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Shipping Instructions - 400 Bad Schema validation () : void
|
Details:
|
Notes:
|
In case the Shipping Instructions does not schema validate a 400 (Bad Request) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Post Shipping Instructions - 500 Internal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Approve Draft Transport Document () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Transport Documents - 202 Accepted () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Update Shipping Instructions () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Put Shipping Instructions - 200 Successful () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Shipping Instructions - 200 Successfull () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Cancel amendment to Confirmed Booking () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
=Mark Booking as CANCELLED () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Submit Updated Shipping Instructions () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Cancel update to Shipping Instructions () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Transport Documents - 200 Successfull () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
>Cancel confirmed Booking () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Patch Shipping Instructions - 202 Accepted () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Shipping Instructions - 200 Succesful () : void
|
Details:
|
Notes:
|
Request successful.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Shipping Instructions - 202 Shipping Instructions being Processed () : void
|
Details:
|
Notes:
|
The Shipping Instructions is currently being processed by the provider. No payload is returned. A new GET request has to be made periodically to check if the provider has finished processing the Shipping Instructions.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Shipping Instructions - 404 Not Found () : void
|
Details:
|
Notes:
|
In case the consumer is requesting the content of the UpdatedShipping Instructions, and no update has yet been requested.<br/><br/>A 404 (Not Found) can also be sent in case the provider does not know of the documentReference used in the request (the resource does not exist)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Shipping Instructions - 409 Reject Incoming Requests/Conflict () : void
|
Details:
|
Notes:
|
In case the provider is processing the Shipping Instructions - it is possible for the provider to reject new incoming requests by returning a 409 (Conflict)<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Shipping Instructions - 500 Internal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Shipping Instructions - Default error () : void
|
Details:
|
Notes:
|
For other errors the error object should be populated with relevant information<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Transport Documents - 200 Succesful () : void
|
Details:
|
Notes:
|
Request successful.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Transport Documents - 202 Transport Documents being Processed () : void
|
Details:
|
Notes:
|
The Transport Document is currently being processed by the provider. No payload is returned. A new GET request has to be made periodically to check if the provider has finished processing the Transport Document.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Transport Documents - 404 Not Found () : void
|
Details:
|
Notes:
|
In case the consumer is requesting a transportDocumentReference that does not exist.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get Transport Documents - 500 Internal Server Error () : void
|
Details:
|
Notes:
|
In case a server error occurs in provider system a 500 (Internal Server Error) is returned.<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
