GET v1/agent/portcalls/{companyCode}?arrivalFromDays={arrivalFromDays}&arrivalToDays={arrivalToDays}&lastModifiedDateTime={lastModifiedDateTime}&apiToken={apiToken}

Returns a list of authorized portcalls for a specific company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The code of the company	string	Required
arrivalFromDays	Number of days before today to retrieve port calls	string	Default value is
arrivalToDays	Number of days after today to retrieve port calls	string	Default value is
lastModifiedDateTime	Only retrieve port calls that have been updated since this datetime (GMT)	date	None.
apiToken	Your API Token	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Object

None.

Response Formats

application/json, text/json

Sample:

[
  {
    "companyCode": "sample string 1",
    "vesselCode": "sample string 2",
    "voyageNo": 3,
    "portCallSeq": 4
  },
  {
    "companyCode": "sample string 1",
    "vesselCode": "sample string 2",
    "voyageNo": 3,
    "portCallSeq": 4
  }
]

application/xml, text/xml

Sample:

<PortCalls xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PortCall>
    <CompanyCode>sample string 1</CompanyCode>
    <VesselCode>sample string 2</VesselCode>
    <VoyageNo>3</VoyageNo>
    <PortCallSeq>4</PortCallSeq>
  </PortCall>
  <PortCall>
    <CompanyCode>sample string 1</CompanyCode>
    <VesselCode>sample string 2</VesselCode>
    <VoyageNo>3</VoyageNo>
    <PortCallSeq>4</PortCallSeq>
  </PortCall>
</PortCalls>