GET api/v1/OceanPortsMaster?search={search}&sort={sort}

Retrieves an array of ocean ports based on the following criteria.

Request Information

Parameters

NameDescriptionAdditional information
search 
ocean port code or name. Minimum length is 3 characters. (required)

Define this parameter in the request URI.
sort 
Field to sort on; prepend + or - to indicate ascending or descending (optional)

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "TheID": 1,
    "Code": "sample string 2",
    "Name": "sample string 2 - sample string 4",
    "NameWoDiacritics": "sample string 4",
    "Subdivision": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Status": "sample string 5",
    "IATA": "sample string 6",
    "Coordinates": "sample string 7",
    "Country": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Location": {
      "lat": 1.1,
      "lng": 2.1
    },
    "IsActivated": true,
    "IsPort": true,
    "IsRail": true,
    "IsRoad": true,
    "IsAirport": true,
    "IsPostal": true
  },
  {
    "TheID": 1,
    "Code": "sample string 2",
    "Name": "sample string 2 - sample string 4",
    "NameWoDiacritics": "sample string 4",
    "Subdivision": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Status": "sample string 5",
    "IATA": "sample string 6",
    "Coordinates": "sample string 7",
    "Country": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Location": {
      "lat": 1.1,
      "lng": 2.1
    },
    "IsActivated": true,
    "IsPort": true,
    "IsRail": true,
    "IsRoad": true,
    "IsAirport": true,
    "IsPostal": true
  },
  {
    "TheID": 1,
    "Code": "sample string 2",
    "Name": "sample string 2 - sample string 4",
    "NameWoDiacritics": "sample string 4",
    "Subdivision": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Status": "sample string 5",
    "IATA": "sample string 6",
    "Coordinates": "sample string 7",
    "Country": {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    "Location": {
      "lat": 1.1,
      "lng": 2.1
    },
    "IsActivated": true,
    "IsPort": true,
    "IsRail": true,
    "IsRoad": true,
    "IsAirport": true,
    "IsPostal": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUNLocodeDTO>
  <UNLocodeDTO>
    <TheID>1</TheID>
    <Code>sample string 2</Code>
    <Name>sample string 2 - sample string 4</Name>
    <NameWoDiacritics>sample string 4</NameWoDiacritics>
    <Subdivision>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Subdivision>
    <Status>sample string 5</Status>
    <IATA>sample string 6</IATA>
    <Coordinates>sample string 7</Coordinates>
    <Country>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Country>
    <Location>
      <lat>1.1</lat>
      <lng>2.1</lng>
    </Location>
    <IsActivated>true</IsActivated>
    <IsPort>true</IsPort>
    <IsRail>true</IsRail>
    <IsRoad>true</IsRoad>
    <IsAirport>true</IsAirport>
    <IsPostal>true</IsPostal>
  </UNLocodeDTO>
  <UNLocodeDTO>
    <TheID>1</TheID>
    <Code>sample string 2</Code>
    <Name>sample string 2 - sample string 4</Name>
    <NameWoDiacritics>sample string 4</NameWoDiacritics>
    <Subdivision>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Subdivision>
    <Status>sample string 5</Status>
    <IATA>sample string 6</IATA>
    <Coordinates>sample string 7</Coordinates>
    <Country>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Country>
    <Location>
      <lat>1.1</lat>
      <lng>2.1</lng>
    </Location>
    <IsActivated>true</IsActivated>
    <IsPort>true</IsPort>
    <IsRail>true</IsRail>
    <IsRoad>true</IsRoad>
    <IsAirport>true</IsAirport>
    <IsPostal>true</IsPostal>
  </UNLocodeDTO>
  <UNLocodeDTO>
    <TheID>1</TheID>
    <Code>sample string 2</Code>
    <Name>sample string 2 - sample string 4</Name>
    <NameWoDiacritics>sample string 4</NameWoDiacritics>
    <Subdivision>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Subdivision>
    <Status>sample string 5</Status>
    <IATA>sample string 6</IATA>
    <Coordinates>sample string 7</Coordinates>
    <Country>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </Country>
    <Location>
      <lat>1.1</lat>
      <lng>2.1</lng>
    </Location>
    <IsActivated>true</IsActivated>
    <IsPort>true</IsPort>
    <IsRail>true</IsRail>
    <IsRoad>true</IsRoad>
    <IsAirport>true</IsAirport>
    <IsPostal>true</IsPostal>
  </UNLocodeDTO>
</ArrayOfUNLocodeDTO>