POST api/PortAreaCalls
Returns any records matching the search criteria provided.
Request Information
URI Parameters
None.
Body Parameters
PortAreaCallsPostParametersName | Description | Type | Additional information |
---|---|---|---|
PortOrPortAreaGuid |
MariData's unique identifier for the port area, or the port. |
globally unique identifier |
Required |
DateStartYYYYMMDD |
The start date of the search. UTC. YYYYMMDD. |
string |
Required |
DateEndYYYYMMDD |
The end date of the search. UTC. YYYYMMDD. |
string |
Required |
VesselIMO |
Allows filtering for specific vessels using their IMO number(s) |
Collection of string |
Max length: 7 Min length: 7 |
VesselType |
Allows filtering for specific vessels using the vessel type |
string |
None. |
VesselSubType |
Allows filtering for specific vessels using the vessel sub type |
string |
None. |
Request Formats
application/json, text/json
{ "PortOrPortAreaGuid": "9e4bc5ab-3301-47ab-87be-22eb066b8515", "DateStartYYYYMMDD": "sample string 2", "DateEndYYYYMMDD": "sample string 3", "VesselIMO": [ "sample string 1", "sample string 2" ], "VesselType": "sample string 4", "VesselSubType": "sample string 5" }
application/xml, text/xml
<PortAreaCallsPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PortOrPortAreaGuid>9e4bc5ab-3301-47ab-87be-22eb066b8515</PortOrPortAreaGuid> <DateStartYYYYMMDD>sample string 2</DateStartYYYYMMDD> <DateEndYYYYMMDD>sample string 3</DateEndYYYYMMDD> <VesselIMO> <string>sample string 1</string> <string>sample string 2</string> </VesselIMO> <VesselType>sample string 4</VesselType> <VesselSubType>sample string 5</VesselSubType> </PortAreaCallsPostParameters>
Response Information
Resource Description
Collection of PortAreaCallName | Description | Type | Additional information |
---|---|---|---|
ArrivalDate |
The date / time the vessel arrived in the area |
date |
None. |
DepartureDate |
The date / time the vessel departed the area |
date |
None. |
PortArea |
The port area where the call took place |
PortArea |
None. |
Vessel |
The vessel that called at the area |
Vessel |
None. |
Response Formats
application/json, text/json
[ { "ArrivalDate": "2021-01-15T15:29:02.7925243+00:00", "DepartureDate": "2021-01-15T15:29:02.7925243+00:00", "PortArea": { "Guid": "d97e38c6-4010-4acb-b47e-e7162072a9e6", "Name": "sample string 2", "Type": "sample string 3", "Terminal": "sample string 4", "Port": { "Guid": "529c5217-2aa7-4baf-b3f3-2c81d03bff33", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2code": "sample string 2" } } }, "Vessel": { "Name": "sample string 1", "IMO": "sample string 2", "MMSI": "sample string 3", "CallSign": "sample string 4", "Flag": { "Name": "sample string 1", "Alpha2code": "sample string 2" }, "Type": "sample string 5", "Dwt": 1, "Length": 1.0, "Breadth": 1.0 } }, { "ArrivalDate": "2021-01-15T15:29:02.7925243+00:00", "DepartureDate": "2021-01-15T15:29:02.7925243+00:00", "PortArea": { "Guid": "d97e38c6-4010-4acb-b47e-e7162072a9e6", "Name": "sample string 2", "Type": "sample string 3", "Terminal": "sample string 4", "Port": { "Guid": "529c5217-2aa7-4baf-b3f3-2c81d03bff33", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2code": "sample string 2" } } }, "Vessel": { "Name": "sample string 1", "IMO": "sample string 2", "MMSI": "sample string 3", "CallSign": "sample string 4", "Flag": { "Name": "sample string 1", "Alpha2code": "sample string 2" }, "Type": "sample string 5", "Dwt": 1, "Length": 1.0, "Breadth": 1.0 } } ]
application/xml, text/xml
<ArrayOfPortAreaCall xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PortAreaCall> <ArrivalDate>2021-01-15T15:29:02.7925243+00:00</ArrivalDate> <DepartureDate>2021-01-15T15:29:02.7925243+00:00</DepartureDate> <PortArea> <Guid>d97e38c6-4010-4acb-b47e-e7162072a9e6</Guid> <Name>sample string 2</Name> <Type>sample string 3</Type> <Terminal>sample string 4</Terminal> <Port> <Guid>529c5217-2aa7-4baf-b3f3-2c81d03bff33</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> <Vessel> <Name>sample string 1</Name> <IMO>sample string 2</IMO> <MMSI>sample string 3</MMSI> <CallSign>sample string 4</CallSign> <Flag> <Name>sample string 1</Name> <Alpha2code>sample string 2</Alpha2code> </Flag> <Type>sample string 5</Type> <Dwt>1</Dwt> <Length>1</Length> <Breadth>1</Breadth> </Vessel> </PortAreaCall> <PortAreaCall> <ArrivalDate>2021-01-15T15:29:02.7925243+00:00</ArrivalDate> <DepartureDate>2021-01-15T15:29:02.7925243+00:00</DepartureDate> <PortArea> <Guid>d97e38c6-4010-4acb-b47e-e7162072a9e6</Guid> <Name>sample string 2</Name> <Type>sample string 3</Type> <Terminal>sample string 4</Terminal> <Port> <Guid>529c5217-2aa7-4baf-b3f3-2c81d03bff33</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> <Vessel> <Name>sample string 1</Name> <IMO>sample string 2</IMO> <MMSI>sample string 3</MMSI> <CallSign>sample string 4</CallSign> <Flag> <Name>sample string 1</Name> <Alpha2code>sample string 2</Alpha2code> </Flag> <Type>sample string 5</Type> <Dwt>1</Dwt> <Length>1</Length> <Breadth>1</Breadth> </Vessel> </PortAreaCall> </ArrayOfPortAreaCall>