Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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:

...

  • 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.

...

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

SpecialInstructionsSpecialInstructions

N

N

String


4

Associates

N

N

--


5

Associate

N

N

--


5

AssociateCode

N

N

String

4

Associates

This field can be used to identify another Trading Party to also send the Notification to

5

ContainerNotificationEmail

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 to

Supply Chain and Partner Port codes

...

String

Semi colon separated list of emails to send Notification emails to


Partner Port and Supply Chain Codes

To receive Notifications for both the terminal and inland port, the PartnerPortCode needs to be specified:

PartnerPortCode

Notifications sent for Sea port and Inland Port

NZTRG

NZTRG - Port of Tauranga (Sulphur Point)
NZMKL - MetroPort Auckland

NZAKL

NZAKL - Ports of Auckland 
NZWII - Wiri, Ports of Auckland South Auckland Freight Hub

NZTIU

NZTIU - Timaru Container Terminal
NZOLT - MetroPort Rolleston

The correct PartnerPortCode and SupplyChainCode must be sent in the ROI message.

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.

If PortConnect cannot find a current active container of the notified supply chain type and Port then the ROI request will be stored for 30 days to wait for a version of the requested container that matches the supplied details.E.g. Container ABCD1234567 is an Import at NZTRG. An ROI is received with supply chain Export and port NZAKL. This will result in the ROI being queued but no notification will be sent unless an export version of this container moves through NZAKL.

If a container cannot be identified then the XML message will display an error and say the ROI is in the Queue waiting.

...