...
Users who receive Events are entitled to one free call to the Container Visit API for each event they receive. Most users subscribe to specific events then once they receive the event they call the Container Visit API to pick up additional container Visit details.
How do Container Visit Event subscriptions work?
Users create Subscriptions to container visits using a combination of Container, Category and Port. When PortConnect finds a container visit that matches the specifies combination then PortConnect starts sending the events that have been registered for.
E.g. user subsribes to receive the Active event against Container XXX which is an Import at Port of Auckland. If/when an Import container called XXX is created in the Port of Auckland system then PortConnect will send the Active event.
Imports and exports can sometimes change ports so PortConnect also provides the option for setting the port as ALL and PortConnect will send events for any matching Container/Category across any port.
What are the different container Categories?
Import - Containers arriving from overseas
Export - Containers departing overseas
Domestic - Containers moving within NZ - This is based on the Load and Discharge ports.
Tranship - Containers moving from one vessel to another vessel
Storage - Empty containers returned to a depot or link facility
What is the typical flow of containers through the ports?
...