Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Insert excerpt
Container Event Subscriptions API
Container Event Subscriptions API
nameCreating a Subscription
nopaneltrue

...

When creating a subscription against a Booking Number, callbacks will be sent for any Export containers with the specified booking number.

Request Body with

...

Booking Numbers

Code Block
{
  "bookings": [
    { "bookingNumber": "MEDU3085895LOPReferenc1", "userDefinedReference" : "User ref 1"},
    { "bookingNumber": "APHU6303593", "userDefinedReference" : "User ref 2"},
    { "bookingNumber": "MEDU5129708", "userDefinedReference" : "User ref 3"}
  ],
  "webhookURI": "https://api.yourcompany.co.nz/webhooks/portconnect", // Optional if emailAddressList is present
  "webhookToken": "yoursecret", // Optional if emailAddressList is present
  "emailAddressList": ["me@test.com"], // Optional if webhookURI and webhookToken are present
  "portCode": "NZTRG",
  "category": "IMPORTEXPORT",
  "eventTypeCode": ["ALL", "DischargeLoad"],
  "facilityCode": null
}

...

Code Block
{
    "subscriptionId": 32,
    "bookings": [
        {
            "expirationDatetime": "2023-06-20T14:50:30.3+12:00",
            "bookingNumber": "TCNU8050683LOPReferenc1",
            "userDefinedReference": "AzureUser Testref 212"
        }
    ]
}

Add label