POST api/PortAreas

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

Name	Description	Type	Additional information
PortGuid	MariData's unique identifier for the port.	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "PortGuid": "ab8de902-67aa-4939-8b9d-e3e771db1bc5"
}

application/xml, text/xml

Sample:

<PortAreasPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PortGuid>ab8de902-67aa-4939-8b9d-e3e771db1bc5</PortGuid>
</PortAreasPostParameters>

Response Information

Resource Description

Collection of PortArea

Name	Description	Type	Additional 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": "c3e9d9fa-5acc-4c24-b7a1-337808614784",
    "Name": "sample string 2",
    "Type": "sample string 3",
    "Terminal": "sample string 4",
    "Port": {
      "Guid": "28b34dc3-5e2e-4fc5-92b0-f77f789cbacb",
      "Name": "sample string 2",
      "Locode": "sample string 3",
      "WpiNumber": "sample string 4",
      "Country": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      }
    }
  },
  {
    "Guid": "c3e9d9fa-5acc-4c24-b7a1-337808614784",
    "Name": "sample string 2",
    "Type": "sample string 3",
    "Terminal": "sample string 4",
    "Port": {
      "Guid": "28b34dc3-5e2e-4fc5-92b0-f77f789cbacb",
      "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>c3e9d9fa-5acc-4c24-b7a1-337808614784</Guid>
    <Name>sample string 2</Name>
    <Type>sample string 3</Type>
    <Terminal>sample string 4</Terminal>
    <Port>
      <Guid>28b34dc3-5e2e-4fc5-92b0-f77f789cbacb</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>c3e9d9fa-5acc-4c24-b7a1-337808614784</Guid>
    <Name>sample string 2</Name>
    <Type>sample string 3</Type>
    <Terminal>sample string 4</Terminal>
    <Port>
      <Guid>28b34dc3-5e2e-4fc5-92b0-f77f789cbacb</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>