GET v1/portActivities/{companyCode}/{portActivityId}?apiToken={apiToken}

Returns information about a specific port activity

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

The company code you are retreiving information for

 string

Required
portActivityId

The ID of the port activity

 integer

Required
apiToken

Your API Token

 string

None.

Body Parameters

None.

Response Information

Resource Description

PortActivityResponse
NameDescriptionTypeAdditional information
Name

string

None.
ID

integer

None.
ActivityTypeCode

string

None.
NeedsCargo

boolean

None.
NeedsBerth

boolean

None.
NeedsROB

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "id": 2,
  "activityTypeCode": "sample string 3",
  "needsCargo": true,
  "needsBerth": true,
  "needsROB": true
}

application/xml, text/xml

Sample: 
<PortActivity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <ID>2</ID>
  <ActivityTypeCode>sample string 3</ActivityTypeCode>
  <NeedsCargo>true</NeedsCargo>
  <NeedsBerth>true</NeedsBerth>
  <NeedsROB>true</NeedsROB>
</PortActivity>