GET v1/agent/portcalls/{companyCode}/details?vesselCode={vesselCode}&voyageNo={voyageNo}&portCallSeq={portCallSeq}&apiToken={apiToken}

Returns details for a specific portcall

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The code of the company	string	Required
vesselCode	The vessel this portcall is associated with	string	Required
voyageNo	The voyage number of this portcall	integer	Required
portCallSeq	The portcall sequence number of this portcall	integer	Required
apiToken	Your API Token	string	None.

Body Parameters

None.

Response Information

Resource Description

PortCallDetailsResponse

Name	Type	Additional information
CompanyCode	string	None.
VesselCode	string	None.
VoyageNo	integer	None.
PortCallSeq	integer	None.
PortNo	integer	None.
PortName	string	None.
UNCode	string	None.
ETAGMT	date	None.
ETDGMT	date	None.
PortFunctionCode	string	None.
OpsCoordinator	string	None.
VoyageCompany	string	None.
NoticeRemarks	string	None.
PortCargoes	Collection of PortCallPortCargo	None.
Agents	Collection of PortCallAgentInfo	None.
Berths	Collection of PortCallBerth	None.

Response Formats

application/json, text/json

Sample:

{
  "companyCode": "sample string 1",
  "vesselCode": "sample string 2",
  "voyageNo": 3,
  "portCallSeq": 4,
  "portNo": 5,
  "portName": "sample string 6",
  "unCode": "sample string 7",
  "etagmt": "2024-11-21T06:48:16.4148969+00:00",
  "etdgmt": "2024-11-21T06:48:16.4148969+00:00",
  "portFunctionCode": "sample string 10",
  "opsCoordinator": "sample string 11",
  "voyageCompany": "sample string 12",
  "noticeRemarks": "sample string 13",
  "portCargoes": [
    {
      "cargoID": 1,
      "fullName": "sample string 2",
      "shortName": "sample string 3",
      "activityType": "sample string 4",
      "quantity": 5,
      "units": "sample string 6",
      "companyCode": "sample string 7",
      "counterpartyShortName": "sample string 8",
      "cargoLaycanFrom": "2024-11-21T06:48:16.4148969+00:00",
      "cargoLaycanTo": "2024-11-21T06:48:16.4148969+00:00",
      "freightType": "sample string 9",
      "cargoLoadPort": "sample string 10",
      "cargoDischargePort": "sample string 11",
      "cpDate": "2024-11-21T06:48:16.4148969+00:00",
      "timeBarDays": 12.1,
      "berthSeqNo": 13,
      "cargoContractID": 14
    },
    {
      "cargoID": 1,
      "fullName": "sample string 2",
      "shortName": "sample string 3",
      "activityType": "sample string 4",
      "quantity": 5,
      "units": "sample string 6",
      "companyCode": "sample string 7",
      "counterpartyShortName": "sample string 8",
      "cargoLaycanFrom": "2024-11-21T06:48:16.4148969+00:00",
      "cargoLaycanTo": "2024-11-21T06:48:16.4148969+00:00",
      "freightType": "sample string 9",
      "cargoLoadPort": "sample string 10",
      "cargoDischargePort": "sample string 11",
      "cpDate": "2024-11-21T06:48:16.4148969+00:00",
      "timeBarDays": 12.1,
      "berthSeqNo": 13,
      "cargoContractID": 14
    }
  ],
  "agents": [
    {
      "type": 1,
      "fullName": "sample string 1",
      "shortName": "sample string 2",
      "address1": "sample string 3",
      "address2": "sample string 4",
      "address3": "sample string 5",
      "address4": "sample string 6",
      "currency": "sample string 7",
      "country": "sample string 8",
      "companyNo": 9,
      "phone": "sample string 10",
      "email": "sample string 11",
      "mainContact": "sample string 12"
    },
    {
      "type": 1,
      "fullName": "sample string 1",
      "shortName": "sample string 2",
      "address1": "sample string 3",
      "address2": "sample string 4",
      "address3": "sample string 5",
      "address4": "sample string 6",
      "currency": "sample string 7",
      "country": "sample string 8",
      "companyNo": 9,
      "phone": "sample string 10",
      "email": "sample string 11",
      "mainContact": "sample string 12"
    }
  ],
  "berths": [
    {
      "berthName": "sample string 1",
      "berthSeqNo": 2,
      "arrivalLocal": "2024-11-21T06:48:16.4148969+00:00",
      "departureLocal": "2024-11-21T06:48:16.4148969+00:00"
    },
    {
      "berthName": "sample string 1",
      "berthSeqNo": 2,
      "arrivalLocal": "2024-11-21T06:48:16.4148969+00:00",
      "departureLocal": "2024-11-21T06:48:16.4148969+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<PortCallDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyCode>sample string 1</CompanyCode>
  <VesselCode>sample string 2</VesselCode>
  <VoyageNo>3</VoyageNo>
  <PortCallSeq>4</PortCallSeq>
  <PortNo>5</PortNo>
  <PortName>sample string 6</PortName>
  <UNCode>sample string 7</UNCode>
  <EtaGmt>2024-11-21T06:48:16.4148969+00:00</EtaGmt>
  <EtdGmt>2024-11-21T06:48:16.4148969+00:00</EtdGmt>
  <PortFunctionCode>sample string 10</PortFunctionCode>
  <OpsCoordinator>sample string 11</OpsCoordinator>
  <VoyageCompany>sample string 12</VoyageCompany>
  <NoticeRemarks>sample string 13</NoticeRemarks>
  <PortCargoes>
    <PortCargo>
      <CargoID>1</CargoID>
      <FullName>sample string 2</FullName>
      <ShortName>sample string 3</ShortName>
      <ActivityType>sample string 4</ActivityType>
      <Quantity>5</Quantity>
      <Units>sample string 6</Units>
      <CompanyCode>sample string 7</CompanyCode>
      <CounterpartyShortName>sample string 8</CounterpartyShortName>
      <CargoLaycanFrom>2024-11-21T06:48:16.4148969+00:00</CargoLaycanFrom>
      <CargoLaycanTo>2024-11-21T06:48:16.4148969+00:00</CargoLaycanTo>
      <FreightType>sample string 9</FreightType>
      <CargoLoadPort>sample string 10</CargoLoadPort>
      <CargoDischargePort>sample string 11</CargoDischargePort>
      <CPDate>2024-11-21T06:48:16.4148969+00:00</CPDate>
      <TimeBarDays>12.1</TimeBarDays>
      <BerthSeqNo>13</BerthSeqNo>
      <CargoContractID>14</CargoContractID>
    </PortCargo>
    <PortCargo>
      <CargoID>1</CargoID>
      <FullName>sample string 2</FullName>
      <ShortName>sample string 3</ShortName>
      <ActivityType>sample string 4</ActivityType>
      <Quantity>5</Quantity>
      <Units>sample string 6</Units>
      <CompanyCode>sample string 7</CompanyCode>
      <CounterpartyShortName>sample string 8</CounterpartyShortName>
      <CargoLaycanFrom>2024-11-21T06:48:16.4148969+00:00</CargoLaycanFrom>
      <CargoLaycanTo>2024-11-21T06:48:16.4148969+00:00</CargoLaycanTo>
      <FreightType>sample string 9</FreightType>
      <CargoLoadPort>sample string 10</CargoLoadPort>
      <CargoDischargePort>sample string 11</CargoDischargePort>
      <CPDate>2024-11-21T06:48:16.4148969+00:00</CPDate>
      <TimeBarDays>12.1</TimeBarDays>
      <BerthSeqNo>13</BerthSeqNo>
      <CargoContractID>14</CargoContractID>
    </PortCargo>
  </PortCargoes>
  <Agents>
    <Agent>
      <AgentType>CharterersAgent</AgentType>
      <FullName>sample string 1</FullName>
      <ShortName>sample string 2</ShortName>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <Address3>sample string 5</Address3>
      <Address4>sample string 6</Address4>
      <Currency>sample string 7</Currency>
      <Country>sample string 8</Country>
      <CompanyNo>9</CompanyNo>
      <Phone>sample string 10</Phone>
      <Email>sample string 11</Email>
      <MainContact>sample string 12</MainContact>
    </Agent>
    <Agent>
      <AgentType>CharterersAgent</AgentType>
      <FullName>sample string 1</FullName>
      <ShortName>sample string 2</ShortName>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <Address3>sample string 5</Address3>
      <Address4>sample string 6</Address4>
      <Currency>sample string 7</Currency>
      <Country>sample string 8</Country>
      <CompanyNo>9</CompanyNo>
      <Phone>sample string 10</Phone>
      <Email>sample string 11</Email>
      <MainContact>sample string 12</MainContact>
    </Agent>
  </Agents>
  <Berths>
    <PortCallBerth>
      <BerthName>sample string 1</BerthName>
      <BerthSeqNo>2</BerthSeqNo>
      <ArrivalLocal>2024-11-21T06:48:16.4148969+00:00</ArrivalLocal>
      <DepartureLocal>2024-11-21T06:48:16.4148969+00:00</DepartureLocal>
    </PortCallBerth>
    <PortCallBerth>
      <BerthName>sample string 1</BerthName>
      <BerthSeqNo>2</BerthSeqNo>
      <ArrivalLocal>2024-11-21T06:48:16.4148969+00:00</ArrivalLocal>
      <DepartureLocal>2024-11-21T06:48:16.4148969+00:00</DepartureLocal>
    </PortCallBerth>
  </Berths>
</PortCallDetails>