POST api/Ports

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

PortsPostParameters
NameDescriptionTypeAdditional information
CountryAlpha2Code

The ISO 2 character country code for the country in which the port is located.

string

Required

Max length: 2

Request Formats

application/json, text/json

Sample:
{
  "CountryAlpha2Code": "sample string 1"
}

application/xml, text/xml

Sample:
<PortsPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CountryAlpha2Code>sample string 1</CountryAlpha2Code>
</PortsPostParameters>

Response Information

Resource Description

Collection of Port
NameDescriptionTypeAdditional information
Guid

globally unique identifier

None.

Name

string

None.

Locode

string

None.

WpiNumber

string

None.

Country

Country

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Guid": "523412b6-65ea-45c0-b63d-cb386214fd32",
    "Name": "sample string 2",
    "Locode": "sample string 3",
    "WpiNumber": "sample string 4",
    "Country": {
      "Name": "sample string 1",
      "Alpha2Code": "sample string 2",
      "Alpha3Code": "sample string 3",
      "NumericCode": "sample string 4",
      "Region": "sample string 5",
      "Continent": "sample string 6"
    }
  },
  {
    "Guid": "523412b6-65ea-45c0-b63d-cb386214fd32",
    "Name": "sample string 2",
    "Locode": "sample string 3",
    "WpiNumber": "sample string 4",
    "Country": {
      "Name": "sample string 1",
      "Alpha2Code": "sample string 2",
      "Alpha3Code": "sample string 3",
      "NumericCode": "sample string 4",
      "Region": "sample string 5",
      "Continent": "sample string 6"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfPort xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Port>
    <Guid>523412b6-65ea-45c0-b63d-cb386214fd32</Guid>
    <Name>sample string 2</Name>
    <Locode>sample string 3</Locode>
    <WpiNumber>sample string 4</WpiNumber>
    <Country>
      <Name>sample string 1</Name>
      <Alpha2Code>sample string 2</Alpha2Code>
      <Alpha3Code>sample string 3</Alpha3Code>
      <NumericCode>sample string 4</NumericCode>
      <Region>sample string 5</Region>
      <Continent>sample string 6</Continent>
    </Country>
  </Port>
  <Port>
    <Guid>523412b6-65ea-45c0-b63d-cb386214fd32</Guid>
    <Name>sample string 2</Name>
    <Locode>sample string 3</Locode>
    <WpiNumber>sample string 4</WpiNumber>
    <Country>
      <Name>sample string 1</Name>
      <Alpha2Code>sample string 2</Alpha2Code>
      <Alpha3Code>sample string 3</Alpha3Code>
      <NumericCode>sample string 4</NumericCode>
      <Region>sample string 5</Region>
      <Continent>sample string 6</Continent>
    </Country>
  </Port>
</ArrayOfPort>