POST api/PortAreas

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

PortAreasPostParameters
NameDescriptionTypeAdditional information
PortGuid

MariData's unique identifier for the port.

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "PortGuid": "c5c1f0b8-9488-4602-8d20-03333c6ba404"
}

application/xml, text/xml

Sample:
<PortAreasPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PortGuid>c5c1f0b8-9488-4602-8d20-03333c6ba404</PortGuid>
</PortAreasPostParameters>

Response Information

Resource Description

Collection of PortArea
NameDescriptionTypeAdditional information
Guid

MariData's unique identifier for this object. Used as the identifier throughout the system.

globally unique identifier

None.

Name

The name of the port area

string

None.

Type

The type of the port area

string

None.

Terminal

The name of the terminal that the berth sits inside (if available / exists)

string

None.

Port

The port that the port area is contained within / attached to

Port

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Guid": "ad05ec17-9f47-4ae3-a4ca-92531fac3eef",
    "Name": "sample string 2",
    "Type": "sample string 3",
    "Terminal": "sample string 4",
    "Port": {
      "Guid": "1a1f976e-a4e3-4f57-9c1a-27ba426ea850",
      "Name": "sample string 2",
      "Locode": "sample string 3",
      "WpiNumber": "sample string 4",
      "Country": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      }
    }
  },
  {
    "Guid": "ad05ec17-9f47-4ae3-a4ca-92531fac3eef",
    "Name": "sample string 2",
    "Type": "sample string 3",
    "Terminal": "sample string 4",
    "Port": {
      "Guid": "1a1f976e-a4e3-4f57-9c1a-27ba426ea850",
      "Name": "sample string 2",
      "Locode": "sample string 3",
      "WpiNumber": "sample string 4",
      "Country": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      }
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfPortArea xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PortArea>
    <Guid>ad05ec17-9f47-4ae3-a4ca-92531fac3eef</Guid>
    <Name>sample string 2</Name>
    <Type>sample string 3</Type>
    <Terminal>sample string 4</Terminal>
    <Port>
      <Guid>1a1f976e-a4e3-4f57-9c1a-27ba426ea850</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>
      </Country>
    </Port>
  </PortArea>
  <PortArea>
    <Guid>ad05ec17-9f47-4ae3-a4ca-92531fac3eef</Guid>
    <Name>sample string 2</Name>
    <Type>sample string 3</Type>
    <Terminal>sample string 4</Terminal>
    <Port>
      <Guid>1a1f976e-a4e3-4f57-9c1a-27ba426ea850</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>
      </Country>
    </Port>
  </PortArea>
</ArrayOfPortArea>