POST api/AreaCheck
Takes a position or array of positions and returns the areas that the point falls within
Request Information
URI Parameters
None.
Body Parameters
The position or array of positions to check
Collection of AreasFromPointParametersName | Description | Type | Additional information |
---|---|---|---|
position_id | string |
None. |
|
location | CoordDec |
None. |
Request Formats
application/json, text/json
Sample:
[ { "position_id": "sample string 1", "location": { "lat": 1.1, "lon": 2.1 } }, { "position_id": "sample string 1", "location": { "lat": 1.1, "lon": 2.1 } } ]
application/xml, text/xml
Sample:
<ArrayOfAreasFromPointParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AreasFromPointParameters> <position_id>sample string 1</position_id> <location> <lat>1.1</lat> <lon>2.1</lon> </location> </AreasFromPointParameters> <AreasFromPointParameters> <position_id>sample string 1</position_id> <location> <lat>1.1</lat> <lon>2.1</lon> </location> </AreasFromPointParameters> </ArrayOfAreasFromPointParameters>
Response Information
Resource Description
Collection of AreasFromPointName | Description | Type | Additional information |
---|---|---|---|
position_id | string |
None. |
|
ocean_name | string |
None. |
|
eez_country_code | string |
None. |
|
eez_country_name | string |
None. |
|
anchorage_name | string |
None. |
|
berthing_area_name | string |
None. |
|
berth_name | string |
None. |
|
port_country_name | string |
None. |
|
port_country_code | string |
None. |
|
port_name | string |
None. |
|
port_uuid | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "position_id": "sample string 1", "ocean_name": "sample string 2", "eez_country_code": "sample string 3", "eez_country_name": "sample string 4", "anchorage_name": "sample string 5", "berthing_area_name": "sample string 6", "berth_name": "sample string 7", "port_country_name": "sample string 8", "port_country_code": "sample string 9", "port_name": "sample string 10", "port_uuid": "587b095c-29b6-4a2d-974a-1131804571e9" }, { "position_id": "sample string 1", "ocean_name": "sample string 2", "eez_country_code": "sample string 3", "eez_country_name": "sample string 4", "anchorage_name": "sample string 5", "berthing_area_name": "sample string 6", "berth_name": "sample string 7", "port_country_name": "sample string 8", "port_country_code": "sample string 9", "port_name": "sample string 10", "port_uuid": "587b095c-29b6-4a2d-974a-1131804571e9" } ]
application/xml, text/xml
Sample:
<ArrayOfAreasFromPoint xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AreasFromPoint> <position_id>sample string 1</position_id> <ocean_name>sample string 2</ocean_name> <eez_country_code>sample string 3</eez_country_code> <eez_country_name>sample string 4</eez_country_name> <anchorage_name>sample string 5</anchorage_name> <berthing_area_name>sample string 6</berthing_area_name> <berth_name>sample string 7</berth_name> <port_country_name>sample string 8</port_country_name> <port_country_code>sample string 9</port_country_code> <port_name>sample string 10</port_name> <port_uuid>587b095c-29b6-4a2d-974a-1131804571e9</port_uuid> </AreasFromPoint> <AreasFromPoint> <position_id>sample string 1</position_id> <ocean_name>sample string 2</ocean_name> <eez_country_code>sample string 3</eez_country_code> <eez_country_name>sample string 4</eez_country_name> <anchorage_name>sample string 5</anchorage_name> <berthing_area_name>sample string 6</berthing_area_name> <berth_name>sample string 7</berth_name> <port_country_name>sample string 8</port_country_name> <port_country_code>sample string 9</port_country_code> <port_name>sample string 10</port_name> <port_uuid>587b095c-29b6-4a2d-974a-1131804571e9</port_uuid> </AreasFromPoint> </ArrayOfAreasFromPoint>