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

The ID of the position. Max 255 characters. Helps ensure that positions returned match up to the positions passed.

string

Max length: 255

Min length: 0

Location

The position to be checked

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

The ID of the position

string

Max length: 255

Min length: 0

OceanName

The name of the ocean

string

Max length: 255

Min length: 0

EEZCountryCode

The 2 character code of the country of the EEZ

string

Max length: 2

Min length: 0

EEZCountryName

The name of the country of the EEZ

string

Max length: 255

Min length: 0

AnchorageName

The name of the anchorage area

string

Max length: 255

Min length: 0

BerthingAreaName

The name of the berthing area

string

Max length: 255

Min length: 0

BerthName

The name of the berth

string

Max length: 255

Min length: 0

PortCountryName

The name of the country of the port

string

Max length: 255

Min length: 0

PortCountryCode

The 2 character country code of the port

string

Max length: 2

Min length: 0

PortName

The name of the port

string

Max length: 255

Min length: 0

PortUuid

The uuid of the port. Unique to MariTrace.

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": "8321ac65-4719-40a0-8b75-819e707f9e5a"
  },
  {
    "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": "8321ac65-4719-40a0-8b75-819e707f9e5a"
  }
]

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>8321ac65-4719-40a0-8b75-819e707f9e5a</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>8321ac65-4719-40a0-8b75-819e707f9e5a</PortUuid>
  </AreasFromPoint>
</ArrayOfAreasFromPoint>