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 AreasFromPointParameters
NameDescriptionTypeAdditional information
PositionID

string

None.

Location

CoordDec

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "PositionID": "sample string 1",
    "Location": {
      "Lat": 1.1,
      "Lon": 2.1
    }
  },
  {
    "PositionID": "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>
    <PositionID>sample string 1</PositionID>
    <Location>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Location>
  </AreasFromPointParameters>
  <AreasFromPointParameters>
    <PositionID>sample string 1</PositionID>
    <Location>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Location>
  </AreasFromPointParameters>
</ArrayOfAreasFromPointParameters>

Response Information

Resource Description

Collection of AreasFromPoint
NameDescriptionTypeAdditional information
PositionID

string

None.

OceanName

string

None.

EEZCountryCode

string

None.

EEZCountryName

string

None.

AnchorageName

string

None.

BerthingAreaName

string

None.

BerthName

string

None.

PortCountryName

string

None.

PortCountryCode

string

None.

PortName

string

None.

PortUuid

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PositionID": "sample string 1",
    "OceanName": "sample string 2",
    "EEZCountryCode": "sample string 3",
    "EEZCountryName": "sample string 4",
    "AnchorageName": "sample string 5",
    "BerthingAreaName": "sample string 6",
    "BerthName": "sample string 7",
    "PortCountryName": "sample string 8",
    "PortCountryCode": "sample string 9",
    "PortName": "sample string 10",
    "PortUuid": "1138d570-4721-4dbb-b944-91b2f8004480"
  },
  {
    "PositionID": "sample string 1",
    "OceanName": "sample string 2",
    "EEZCountryCode": "sample string 3",
    "EEZCountryName": "sample string 4",
    "AnchorageName": "sample string 5",
    "BerthingAreaName": "sample string 6",
    "BerthName": "sample string 7",
    "PortCountryName": "sample string 8",
    "PortCountryCode": "sample string 9",
    "PortName": "sample string 10",
    "PortUuid": "1138d570-4721-4dbb-b944-91b2f8004480"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAreasFromPoint xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AreasFromPoint>
    <PositionID>sample string 1</PositionID>
    <OceanName>sample string 2</OceanName>
    <EEZCountryCode>sample string 3</EEZCountryCode>
    <EEZCountryName>sample string 4</EEZCountryName>
    <AnchorageName>sample string 5</AnchorageName>
    <BerthingAreaName>sample string 6</BerthingAreaName>
    <BerthName>sample string 7</BerthName>
    <PortCountryName>sample string 8</PortCountryName>
    <PortCountryCode>sample string 9</PortCountryCode>
    <PortName>sample string 10</PortName>
    <PortUuid>1138d570-4721-4dbb-b944-91b2f8004480</PortUuid>
  </AreasFromPoint>
  <AreasFromPoint>
    <PositionID>sample string 1</PositionID>
    <OceanName>sample string 2</OceanName>
    <EEZCountryCode>sample string 3</EEZCountryCode>
    <EEZCountryName>sample string 4</EEZCountryName>
    <AnchorageName>sample string 5</AnchorageName>
    <BerthingAreaName>sample string 6</BerthingAreaName>
    <BerthName>sample string 7</BerthName>
    <PortCountryName>sample string 8</PortCountryName>
    <PortCountryCode>sample string 9</PortCountryCode>
    <PortName>sample string 10</PortName>
    <PortUuid>1138d570-4721-4dbb-b944-91b2f8004480</PortUuid>
  </AreasFromPoint>
</ArrayOfAreasFromPoint>