| Table of Contents |
|---|
What are Notifications?
...
| Table of Contents |
|---|
What are Notifications?
PortConnect can send email notifications when a range of events/changes occur against containers. Notification types include:
...
By registering interest in containers you are registering to receive notifications for all the default notification types you are signed up for. Read the What are Notifications section to learn more about Notification types.
...
What does a Notification email look like?
...
If an ROI is received but PortConnect cannot find an active version of the container then you will receive an Acknowledgment email identifying the ROI is in the queue (see the following section).
...
How long will the ROI
...
Users can send multiple Customer References per container. This is an unlimited character field and designed to support container visit identifiers.
The Customer Reference will be included in the Notification (both in the email body and XML file attached).
To include this in the ROI, each Customer Reference needs to be set for each container segment.
If you submit a new ROI it will overwrite the existing ROI including the Customer Reference.
If you have already received Notifications against the first ROI you would receive them again against the new ROI with the new Customer Reference included in the Notification.
If you submit an ROI with the same Customer Reference as the previous ROI, it will not send new Notifications.
How long will the ROI be queued for?
ROI's may be queued because PortConnect does not yet have a record of the container or because the information you have submitted does not match the details of the container you are trying to register interest in.
If an ROI is queued, it will stay queued for 30 days. After the 30 days are up the ROI request will be removed.
If PortConnect receives a record of the container within the 30 days then the ROI will be applied but you will not receive a success message - you will simply start receiving notifications.
PortConnect does not receive Import and Arriving Tranship container information from the ports until after the vessel leaves the previous port. Therefore, some containers may not come through to PortConnect until half a day or a day before the vessel is due to arrive at the port.
How will I know if the ROI has succeeded?
You will receive an automated acknowledgement email to confirm that the ROI message has been received.
...
There is an XML file attached which specifies whether the ROI was Successful or Queued.
...
If you receive an acknowledgement response message where there is no customer reference, no success or queued status then there is an error with your customer code in you ROI XML. Contact info@portconnect.co.nz to check you have the correct code for your company.
...
be queued for?
ROI's may be queued because PortConnect does not yet have a record of the container or because the information you have submitted does not match the details of the container you are trying to register interest in.
If an ROI is queued, it will stay queued for 30 days. After the 30 days are up the ROI request will be removed.
If PortConnect receives a record of the container within the 30 days then the ROI will be applied but you will not receive a success message - you will simply start receiving notifications.
PortConnect does not receive Import and Arriving Tranship container information from the ports until after the vessel leaves the previous port. Therefore, some containers may not come through to PortConnect until half a day or a day before the vessel is due to arrive at the port.
...
How will I know if the ROI has succeeded?
You will receive an automated acknowledgement email to confirm that the ROI message has been received.
...
There is an XML file attached which specifies whether the ROI was Successful or Queued.
...
If you receive an acknowledgement response message where there is no customer reference, no success or queued status then there is an error with your customer code in you ROI XML. Contact info@portconnect.co.nz to check you have the correct code for your company.
Note - We recommend that you set up an automated process to record whether an Acknowledgment message has been received or not. If you do not receive an Acknowledgment email then please contact info@portconnect.co.nz as soon as possible so that we can investigate for you.
...
Note: XML Elements are case sensitive and must display exactly as per below
Level | XML Element | Req’d | Repeats | Data Type | Description | ||||||
0 | AutoTrack xmlns:ns0="http://PortConnect/B2BIn/External/B2B_RoI/20132211" | Y | N | -- | This is the message header and includes an attribute. This must match exactly what is in the below examples. Please note that the header of the Notification XML is different from the header of the ROI XML as these are two separate processes. The B2B ROI message must always have the ROI header as shown in the below examples. | ||||||
1 | Header | Y | N | -- | |||||||
2 | Timestamp | Y | N | Datetime | e.g. 2014-05-31T13:20:00.000 | ||||||
2 | SenderReference | Y | N | String | This is your own internal reference to help you identify the ROI request message. The sender reference will be included in the response acknowledgment email you receive from PortConnect but will not be included in Notification emails. | ||||||
2 | CustomerCode | Y | N | String | PortConnect will inform you on what this code is | ||||||
2 | CustomerPassword | N | N | String | Segment is not mandatory but you wish to include it then enter “unknown” - (function still in development) | ||||||
2 | RoIAcknowledgementEmail | Y | Y | String | Semi colon separated list of emails to send the ROI receival Acknowledgment email to | ||||||
2 | ContainerNotificationEmail | Y | N | String | This segment is mandatory but is no longer used. The value can be left blank or your can enter the email from the acknowledgment segment. | ||||||
1 | RegisterOfInterest | Y | N | -- | |||||||
2 | Containers | Y | N | -- | |||||||
3 | Container | Y | Y | -- | |||||||
4 | PartnerPortCode | Y | N | String | NZAKL, NZTRG or NZTIU | ||||||
4 | ContainerNumber | Y | N | String | Container Number | ||||||
4 | CustomerReference | N | N | String | This is your own internal reference | ||||||
4 | ClientReference | N | N | String | This is your own internal reference | ||||||
4 | SupplyChainCode | Y | N | String | Enter E, I, T or D. E= Export, I= Import, T=Transhipment, D=Domestic. Domestic is used for any container that has Load and Discharge ports that are both in NZ. | ||||||
4 | SpecialInstructions | N | N | String | |||||||
4 | Associates | N | N | -- | |||||||
5 | Associate | N | N | -- | |||||||
5 | AssociateCode | N | N | String | This field can be used to identify another Trading Party to also send the Notification to | 5 | ContainerNotificationEmail | N | N | String | Semi colon separated list of emails to send Notification emails toused to identify another Trading Party to also send the Notification to |
5 | ContainerNotificationEmail | N | N | String | Semi colon separated list of emails to send Notification emails to |
Customer Reference within the ROI
Users can send multiple Customer References per container. This is an unlimited character field and designed to support container visit identifiers.
The Customer Reference will be included in the Notification (both in the email body and XML file attached).
To include this in the ROI, each Customer Reference needs to be set for each container segment.
If you submit a new ROI it will overwrite the existing ROI including the Customer Reference.
If you have already received Notifications against the first ROI you would receive them again against the new ROI with the new Customer Reference included in the Notification.
If you submit an ROI with the same Customer Reference as the previous ROI, it will not send new Notifications.
Partner Port and Supply Chain Codes
...
PartnerPortCode | Notifications sent for Sea port and Inland Port |
|---|---|
NZTRG | NZTRG - Port of Tauranga (Sulphur Point) |
NZAKL | NZAKL - Ports of Auckland |
NZTIU | NZTIU - Timaru Container Terminal |
...
E.g. Container ABCD1234567 is an Import at NZTRG.
An ROI is received with SupplyChainCode 'E' (Export) and PartnerPortCode ‘NZAKL’.
This will result in the ROI being queued but no notification will be sent unless anExport version of this container moves through NZAKL.
Once a ROI message is received, PortConnect attempts to identify the container based on the notified Supply Chain and Port codes.
...