POST api/Ports

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

PortsPostParameters

Name	Description	Type	Additional information
CountryAlpha2Code	The ISO 2 character country code for the country in which the port is located.	string	Required Max length: 2

Name

Description

Type

Additional 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

Name	Description	Type	Additional information
Guid	MariData's unique identifier for this object. Used as the identifier throughout the system.	globally unique identifier	None.
Name	The name of the port	string	None.
Locode	The Locode of the port	string	None.
WpiNumber	The WPI number of the port	string	None.
Country	The country containing that port	Country	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Guid": "e282f797-711d-4103-87c1-cc5d4373da58",
    "Name": "sample string 2",
    "Locode": "sample string 3",
    "WpiNumber": "sample string 4",
    "Country": {
      "Name": "sample string 1",
      "Alpha2code": "sample string 2"
    }
  },
  {
    "Guid": "e282f797-711d-4103-87c1-cc5d4373da58",
    "Name": "sample string 2",
    "Locode": "sample string 3",
    "WpiNumber": "sample string 4",
    "Country": {
      "Name": "sample string 1",
      "Alpha2code": "sample string 2"
    }
  }
]

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>e282f797-711d-4103-87c1-cc5d4373da58</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>
    </Country>
  </Port>
  <Port>
    <Guid>e282f797-711d-4103-87c1-cc5d4373da58</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>
    </Country>
  </Port>
</ArrayOfPort>