...
| Insert excerpt |
|---|
| Container Event Subscriptions |
|---|
| Container Event Subscriptions |
|---|
| name | Creating a Subscription |
|---|
| nopanel | true |
|---|
|
Endpoint
| Code Block |
|---|
POST https://api.portconnect.io/v1/subscriptions |
Request example using Container Numbers
Request Body with Container Numbers
| Code Block |
|---|
{
"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": "AVAILABLE",
"facilityCode": null
} |
Response Body with containers:
| Code Block |
|---|
{
"subscriptionId": 32,
"containers": [
{
"expirationDatetime": "2023-06-20T14:50:30.3+12:00",
"containerNumber": "TCNU8050683",
"userDefinedReference": "Azure Test 2"
}
]
} |
Request example using Booking Numbers
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": "LOPReference1", "userDefinedReference" : "User ref 1"}
],
"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": "AVAILABLE",
"facilityCode": null
} |
Response Body with bookings:
| Code Block |
|---|
{
"subscriptionId": 32,
"bookings": [
{
"expirationDatetime": "2023-06-20T14:50:30.3+12:00",
"bookingNumber": "LOPReference1",
"userDefinedReference": "User Ref 1"
}
]
} |