Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Error rendering macro 'excerpt-include' : No link could be created for 'Container Event Subscriptions'.

Endpoint

POST https://api.portconnect.io/v2/subscriptions

Request Body with Container Numbers

{
  "containers": [
    { "containerNumber": "MEDU3085895", "userDefinedReference" : "User ref 1"},
    { "containerNumber": "APHU6303593", "userDefinedReference" : "User ref 2"},
    { "containerNumber": "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": "IMPORT",
  "eventTypeCode": ["ALL", "Discharge"],
  "facilityCode": null
}

 

Response Body with containers:

{
    "subscriptionId": 32,
    "containers": [
        {
            "expirationDatetime": "2023-06-20T14:50:30.3+12:00",
            "containerNumber": "TCNU8050683",
            "userDefinedReference": "Azure Test 2"
        }
    ]
}

 

Request example using Booking Numbers

Request Body with Container Numbers

{
  "bookings": [
    { "bookingNumber": "MEDU3085895", "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": "IMPORT",
  "eventTypeCode": ["ALL", "Discharge"],
  "facilityCode": null
}

 

Response Body with bookings:

{
    "subscriptionId": 32,
    "bookings": [
        {
            "expirationDatetime": "2023-06-20T14:50:30.3+12:00",
            "bookingNumber": "TCNU8050683",
            "userDefinedReference": "Azure Test 2"
        }
    ]
}

Add label

  • No labels