POST api/PortCalls
Returns any records matching the search criteria provided.
Request Information
URI Parameters
None.
Body Parameters
PortCallsPostParametersName | Description | Type | Additional information |
---|---|---|---|
PortGuid |
MariData's unique identifier for 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 a list of vessel types (full non case-sensitive name, e.g. Bulk Carrier) |
Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "PortGuid": "2add8d63-a213-4fb5-b756-f6be45e1e62f", "DateStartYYYYMMDD": "sample string 2", "DateEndYYYYMMDD": "sample string 3", "VesselIMO": [ "sample string 1", "sample string 2" ], "VesselType": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<PortCallsPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PortGuid>2add8d63-a213-4fb5-b756-f6be45e1e62f</PortGuid> <DateStartYYYYMMDD>sample string 2</DateStartYYYYMMDD> <DateEndYYYYMMDD>sample string 3</DateEndYYYYMMDD> <VesselIMO> <string>sample string 1</string> <string>sample string 2</string> </VesselIMO> <VesselType> <string>sample string 1</string> <string>sample string 2</string> </VesselType> </PortCallsPostParameters>
Response Information
Resource Description
Collection of PortCall_VesselName | Description | Type | Additional information |
---|---|---|---|
Port | Port |
None. |
|
Timing | Timing |
None. |
|
Vessel | Vessel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Port": { "Guid": "0ffb5528-0d30-41e0-979d-1678daaf7c39", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2Code": "sample string 2", "Alpha3Code": "sample string 3", "NumericCode": "sample string 4", "Region": "sample string 5", "Continent": "sample string 6" } }, "Timing": { "StartDateTime": "2023-10-03T13:38:45.9422401+00:00", "EndDateTime": "2023-10-03T13:38:45.9422401+00:00" }, "Vessel": { "VesselIdentifier": "sample string 1", "Name": "sample string 2", "IMO": "sample string 3", "MMSI": "sample string 4", "CallSign": "sample string 5", "Flag": { "Name": "sample string 1", "Alpha2Code": "sample string 2", "Alpha3Code": "sample string 3", "NumericCode": "sample string 4", "Region": "sample string 5", "Continent": "sample string 6" }, "AISType": "sample string 6", "Type": "sample string 7", "SubType": "sample string 8", "Dwt": 1, "Length": 1.0, "Breadth": 1.0, "CommercialOwner": "sample string 9", "EffectiveController": "sample string 10", "TechnicalManager": "sample string 11", "FinancialOwner": "sample string 12" } }, { "Port": { "Guid": "0ffb5528-0d30-41e0-979d-1678daaf7c39", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2Code": "sample string 2", "Alpha3Code": "sample string 3", "NumericCode": "sample string 4", "Region": "sample string 5", "Continent": "sample string 6" } }, "Timing": { "StartDateTime": "2023-10-03T13:38:45.9422401+00:00", "EndDateTime": "2023-10-03T13:38:45.9422401+00:00" }, "Vessel": { "VesselIdentifier": "sample string 1", "Name": "sample string 2", "IMO": "sample string 3", "MMSI": "sample string 4", "CallSign": "sample string 5", "Flag": { "Name": "sample string 1", "Alpha2Code": "sample string 2", "Alpha3Code": "sample string 3", "NumericCode": "sample string 4", "Region": "sample string 5", "Continent": "sample string 6" }, "AISType": "sample string 6", "Type": "sample string 7", "SubType": "sample string 8", "Dwt": 1, "Length": 1.0, "Breadth": 1.0, "CommercialOwner": "sample string 9", "EffectiveController": "sample string 10", "TechnicalManager": "sample string 11", "FinancialOwner": "sample string 12" } } ]
application/xml, text/xml
Sample:
<ArrayOfPortCall_Vessel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PortCall_Vessel> <Port> <Guid>0ffb5528-0d30-41e0-979d-1678daaf7c39</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> <Alpha3Code>sample string 3</Alpha3Code> <NumericCode>sample string 4</NumericCode> <Region>sample string 5</Region> <Continent>sample string 6</Continent> </Country> </Port> <Timing> <StartDateTime>2023-10-03T13:38:45.9422401+00:00</StartDateTime> <EndDateTime>2023-10-03T13:38:45.9422401+00:00</EndDateTime> </Timing> <Vessel> <VesselIdentifier>sample string 1</VesselIdentifier> <Name>sample string 2</Name> <IMO>sample string 3</IMO> <MMSI>sample string 4</MMSI> <CallSign>sample string 5</CallSign> <Flag> <Name>sample string 1</Name> <Alpha2Code>sample string 2</Alpha2Code> <Alpha3Code>sample string 3</Alpha3Code> <NumericCode>sample string 4</NumericCode> <Region>sample string 5</Region> <Continent>sample string 6</Continent> </Flag> <AISType>sample string 6</AISType> <Type>sample string 7</Type> <SubType>sample string 8</SubType> <Dwt>1</Dwt> <Length>1</Length> <Breadth>1</Breadth> <CommercialOwner>sample string 9</CommercialOwner> <EffectiveController>sample string 10</EffectiveController> <TechnicalManager>sample string 11</TechnicalManager> <FinancialOwner>sample string 12</FinancialOwner> </Vessel> </PortCall_Vessel> <PortCall_Vessel> <Port> <Guid>0ffb5528-0d30-41e0-979d-1678daaf7c39</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> <Alpha3Code>sample string 3</Alpha3Code> <NumericCode>sample string 4</NumericCode> <Region>sample string 5</Region> <Continent>sample string 6</Continent> </Country> </Port> <Timing> <StartDateTime>2023-10-03T13:38:45.9422401+00:00</StartDateTime> <EndDateTime>2023-10-03T13:38:45.9422401+00:00</EndDateTime> </Timing> <Vessel> <VesselIdentifier>sample string 1</VesselIdentifier> <Name>sample string 2</Name> <IMO>sample string 3</IMO> <MMSI>sample string 4</MMSI> <CallSign>sample string 5</CallSign> <Flag> <Name>sample string 1</Name> <Alpha2Code>sample string 2</Alpha2Code> <Alpha3Code>sample string 3</Alpha3Code> <NumericCode>sample string 4</NumericCode> <Region>sample string 5</Region> <Continent>sample string 6</Continent> </Flag> <AISType>sample string 6</AISType> <Type>sample string 7</Type> <SubType>sample string 8</SubType> <Dwt>1</Dwt> <Length>1</Length> <Breadth>1</Breadth> <CommercialOwner>sample string 9</CommercialOwner> <EffectiveController>sample string 10</EffectiveController> <TechnicalManager>sample string 11</TechnicalManager> <FinancialOwner>sample string 12</FinancialOwner> </Vessel> </PortCall_Vessel> </ArrayOfPortCall_Vessel>