GET v1/delayTypes/{companyCode}/{delayTypeId}?apiToken={apiToken}

Returns information about a specific delay type

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company code you are retreiving information for	string	Required
delayTypeId	The ID of the delay type	integer	Required
apiToken	Your API Token	string	None.

Body Parameters

None.

Response Information

Resource Description

DelayTypeResponse

Name	Type	Additional information
ID	integer	None.
Name	string	None.
IsVesselStopped	boolean	None.
Reasons	Collection of DelayTypeResponseReason	None.
Code	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "isVesselStopped": true,
  "reasons": [
    {
      "id": 1,
      "name": "sample string 2",
      "subReasons": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "subReasons": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ]
    }
  ],
  "code": "sample string 4"
}

application/xml, text/xml

Sample:

<DelayType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <Name>sample string 2</Name>
  <IsVesselStopped>true</IsVesselStopped>
  <Reasons>
    <Reason>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <SubReasons>
        <SubReason>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </SubReason>
        <SubReason>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </SubReason>
      </SubReasons>
    </Reason>
    <Reason>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <SubReasons>
        <SubReason>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </SubReason>
        <SubReason>
          <ID>1</ID>
          <Name>sample string 2</Name>
        </SubReason>
      </SubReasons>
    </Reason>
  </Reasons>
  <Code>sample string 4</Code>
</DelayType>