POST api/Countries
Returns any records matching the search criteria provided.
Request Information
URI Parameters
None.
Body Parameters
The parameters for the search
CountriesPostParameters| Name | Description | Type | Additional 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| Name | Description | Type | Additional information |
|---|---|---|---|
| name | string |
None. |
|
| alpha_2_code | string |
None. |
|
| alpha_3_code | string |
None. |
|
| numeric_code | string |
None. |
|
| region | string |
None. |
|
| continent | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"name": "sample string 1",
"alpha_2_code": "sample string 2",
"alpha_3_code": "sample string 3",
"numeric_code": "sample string 4",
"region": "sample string 5",
"continent": "sample string 6"
},
{
"name": "sample string 1",
"alpha_2_code": "sample string 2",
"alpha_3_code": "sample string 3",
"numeric_code": "sample string 4",
"region": "sample string 5",
"continent": "sample string 6"
}
]
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>
<alpha_2_code>sample string 2</alpha_2_code>
<alpha_3_code>sample string 3</alpha_3_code>
<numeric_code>sample string 4</numeric_code>
<region>sample string 5</region>
<continent>sample string 6</continent>
</Country>
<Country>
<name>sample string 1</name>
<alpha_2_code>sample string 2</alpha_2_code>
<alpha_3_code>sample string 3</alpha_3_code>
<numeric_code>sample string 4</numeric_code>
<region>sample string 5</region>
<continent>sample string 6</continent>
</Country>
</ArrayOfCountry>