POST api/Countries

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

CountriesPostParameters
NameDescriptionTypeAdditional information
Name

The country in which the port is located. Alphanumerics [0-9a-zA-Z] and '*' wilcard allowed. Case insensitive. Spaces must be encoded.

string

None.

Alpha2code

The ISO 2 character country code for the country in which the port is located. Alphanumerics [0-9a-zA-Z] and '*' wilcard allowed. Case insensitive.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Alpha2code": "sample string 2"
}

application/xml, text/xml

Sample:
<CountriesPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <Alpha2code>sample string 2</Alpha2code>
</CountriesPostParameters>

Response Information

Resource Description

Collection of Country
NameDescriptionTypeAdditional information
Name

The name of the country

string

None.

Alpha2code

The UN 2-character code for the country. Used as the identifier throughout the system.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Alpha2code": "sample string 2"
  },
  {
    "Name": "sample string 1",
    "Alpha2code": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCountry xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Country>
    <Name>sample string 1</Name>
    <Alpha2code>sample string 2</Alpha2code>
  </Country>
  <Country>
    <Name>sample string 1</Name>
    <Alpha2code>sample string 2</Alpha2code>
  </Country>
</ArrayOfCountry>