POST api/Ports
Returns any records matching the search criteria provided.
Request Information
URI Parameters
None.
Body Parameters
The parameters for the search
PortsPostParametersName | 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 PortName | Description | Type | Additional 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": "65414743-d971-4d54-a87b-15295fc6ce69", "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": "65414743-d971-4d54-a87b-15295fc6ce69", "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>65414743-d971-4d54-a87b-15295fc6ce69</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>65414743-d971-4d54-a87b-15295fc6ce69</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>