Developer Portal
Insights
PurpleTRACMTIPodium
Other
Other
  • Weather
Insights
PurpleTRACMTIPodium
Other
Other
  • Weather
    • Start Here
      • API Overview
      • Getting Started
      • Authentication
      • Quick Start
      • Testing & Sandbox
    • Concepts & Terminology
      • Concepts & Terminology
      • Notifications & Webhooks
      • Errors & Status Codes
      • Pagination & Filtering
      • Versioning & Deprecation
      • Changelog
    • Reference Data
      • Vessel Types
      • Vessel Classes
      • Vessel Statuses
      • Zone & Port Types
    • Build & Operate
      • AI Assistants & Agents
      • FAQ
      • SDKs & Code Generation
    • Vessel & Voyage
      • Overview
      • Vessel Insights
        • Overview
        • Vessel Search
        • Vessel Characteristics
      • Voyage Insights
        • Overview
        • Worked Examples
        • Vessel Port Calls
        • Vessel Zone & Port Events
        • Vessel AIS Reporting Gaps
        • Vessel STS Pairings
        • Positional Discrepancies
        • Port State Control
      • Vessel Positions
        • Vessel Positions
        • Historical Vessel Track
        • Latest Vessel Positions
      • Vessel Notifications
        • Worked Examples
        • Get Vessel Notification Subscriptions
        • Create Vessel Notification Subscription
        • Get Vessel Notification Subscription
        • Edit Vessel Notification Subscription
        • Get Vessel Notifications by Subscription ID
        • Get All Vessel Notifications
        • Delete Vessel Notification Subscription
    • Port & Trade
      • Overview
      • Choosing Port Endpoints
      • Port Insights
        • Port Insights
        • Berth Calls by Port
        • Inbound Vessels
      • Port Analytics
        • Port Analytics
        • Port Analytics: Worked Examples
        • Berth KPIs
        • Berth Details
        • Port Arrival & Departure Analytics
    • Domain & Fleet
      • Overview
      • Choosing Zone Endpoints
      • Zone Insights
        • Overview
      • Zone Analytics
        • Zone Analytics
        • Zone Analytics: Worked Examples
        • Zone Entry & Exit Analytics
      • Fleet Management
        • Fleet Management
        • Fleet Management: Worked Examples
        • List Fleets
        • Create Fleet
        • Get Fleet Details
        • Delete Fleet
        • Update Fleet
        • List Fleet Vessels
        • Get Fleet Composition
        • List Fleet Events
      • Custom Zones
        • Custom Zones
        • Create Custom Zone
        • Edit Custom Zone
    • Zones & Ports
      • Overview
      • Zone & Port Insights
        • Zone & Port Search
        • Get Single Zone or Port
        • Zone & Port Traffic
        • Vessels in Zone or Port
      • Zone & Port Notifications
        • Zone & Port Notifications
        • Zone & Port Notifications: Worked Examples
        • Create Zone & Port Notification Subscription
        • Get Zone & Port Notification Subscriptions
        • Edit Zone & Port Notification Subscription
        • Delete Zone & Port Notification Subscription
        • Get Zone & Port Notification Subscription
        • Search Zone & Port Notifications
        • Get Zone & Port Notifications by Subscription ID
        • Get All Zone & Port Notifications
    • Schemas
      • VesselTankerCharacteristicsResponse
      • ImoBatchSearchResponse
      • ReportedDestination
      • AisFieldDeltaNavigationalStatus
      • AisFieldDeltaErrorResponse
      • BerthDetailsDto
      • BerthListQuery
      • BerthPortInfoDto
      • BerthSummaryDto
      • DwellTimeDataPointDto
      • OccupancyDto
      • PortAnalyticsItem
      • PortAnalyticsQuery
      • PortAnalyticsResponse
      • PortAnalyticsTotals
      • TopVisitorDto
      • VesselTypeMixDto
      • ZoneAnalyticsItem
      • ZoneAnalyticsQuery
      • ZoneAnalyticsResponse
      • ZoneDetail
      • PortDetail
      • PositionReport
      • PositionalDiscrepancyEvent
      • AisSpoofingErrorResponse
      • AisSpoofingVesselInformation
      • VesselPortsFilter
      • ZoneDetails
      • PortDetails
      • CustomZoneDetails
      • CircleDetails
      • PortEventDetails
      • PortCallEventDetails
      • BerthInformationPortCall
      • PortVessel
      • PortListResponse
      • ZoneDefinitionResponse
      • CustomZoneResponse
      • ArrivalsDeparturesResponse
      • VesselsInZonePortResponse
      • BerthEventsResponse
      • VoyagePortCallsResponse
      • VoyageZonePortEventsResponse
      • CustomZoneRequest
      • CustomCircle
      • ZoneServiceErrorResponse
      • ZoneServiceVesselInformation
      • VesselIdentifier
      • LatestVesselFilter
      • CircleZone
      • PolygonZone
      • GeographicFilter
      • HistoricalPositionSearchRequest
      • LatestPositionSearchRequest
      • VesselInfo
      • MatchedDestination
      • ConsolidatedPosition
      • CpsApiErrorResponse
      • CpsApiPaginationMeta
      • CpsApiNavigationalStatus
      • AnalyticsServiceErrorResponse
      • ResponseMeta
      • FlagDetail
      • CountryOfBuild
      • Ownership
      • VesselTankerCharacteristics
      • VesselCharacteristicsResponse
      • VesselSummary
      • VesselSearchResponse
      • ImoBatchSearchMeta
      • ImoBatchSearchSummary
      • ImoVesselSummary
      • ImoErrorEntry
      • ImoBatchSearchData
      • AssetInformationServiceErrorResponse
      • AssetInformationServiceDimensions
      • AssetInformationServiceVesselCharacteristics
      • EmailSettingsDTO
      • VesselFilterRequestDTO
      • ZonePortFilterRequestResponseDTO
      • SettingsResponseDto
      • SubscriptionResponseDTO
      • NotificationResponseDTO
      • EventNotificationServiceMetaData
      • BerthEventDetails
      • PscInspection
      • CustomPolygon
      • ZoneServiceMeta
      • HistoricalPositionsResponse
      • FleetListResponse
      • FleetListMeta
      • FleetSummary
      • FleetItem
      • VesselPosition
      • FleetVesselItem
      • FleetDetailMeta
      • FleetDetail
      • AnalyticsServiceVesselInformation
      • FailedVessel
      • CreateFleetV2Request
      • CreateFleetV2Response
      • UpdateFleetV2Request
      • FleetManagementApiMeta
      • FleetManagementApiErrorResponse
      • AssetInformationServiceCountryOfBuild
      • BerthDetailMetaDto
      • FleetEventNavigationalStatus
      • LegacyStsPairingsResponse
      • VesselZonesFilter
      • EventNotificationServiceErrorResponse
      • VesselAisReportingGapsFilter
      • GapReportingErrorResponse
      • VesselStsPairingsFilter
      • VoyageVesselInformation
      • StsPairingsResponse
      • VesselPositionalDiscrepanciesFilter
      • VesselDraughtChangeFilter
      • PscInspectionServiceErrorResponse
      • ReportingStatus
      • VesselAisDestinationChangeFilter
      • DaysNotReportingRange
      • VesselAisEtaChangeFilter
      • AnalyticsServiceMeta
      • VesselMmsiChangeFilter
      • FleetInformation
      • VesselNavigationalStatusChangeFilter
      • FleetCompositionResponse
      • CompositionData
      • VesselInboundBaseResponse
      • Summary
      • TypeAndClass
      • RegistrationAndFlag
      • AnalyticsServiceCountryOfBuild
      • BuildAndOrigin
      • SizeAndDimensions
      • CategoryItem
      • ChartSection
      • RankedSection
      • BerthDetailQueryDto
      • SizeSection
      • DimensionsSection
      • AisGapStartedPosition
      • AisGapEndedPosition
      • ZoneCentroid
      • GapReportingMetaData
      • ZoneInformation
      • StsPairingServiceMeta
      • PscPortInformation
      • AisSpoofingMeta
      • FleetEventsResponse
      • PscInspectionServiceMetaData
      • FleetEventsData
      • ZoneServicePaginationMeta
      • EventVesselInformation
      • VesselInbound
      • ZoneEventDetails
      • ZoneEventResponse
      • Schedule
      • AisGapEventResponse
      • StsPairingEventResponse
      • StsPairedVessel
      • PositionalDiscrepancyEventResponse
      • Centroid
      • DiscrepancyPositionStart
      • DiscrepancyPositionEnd
      • PscEventResponse
      • BerthDetailResponseDto
      • GapEventsResponse
      • StsPairingsData
      • PscInspectionsResponse
      • Point
      • GapEventData
      • StsPairingEvent
      • PscInspectionData
      • LatestPosition
      • VesselScreening
      • GapEvent
      • Location
      • BerthKpiDto
      • FlagCodesDTO
      • PortInformation
      • BerthListMeta
      • GapPosition
      • StsPairingServiceVesselInformation
      • AnalyticsServiceNavigationalStatus
      • AisFieldDeltaVesselInformation
      • VesselStatus
      • GapReportingNavigationalStatus
      • StsPairingServiceErrorResponse
      • PscInspectionServiceVesselInformation
      • AisFieldDeltaMetaData
      • BerthListResponseDto
      • GapReportingVesselInformation
      • VesselSettingsRequestDto
      • LegacyMeta
      • PolygonDetails
      • PositionalDiscrepancyData
      • ZonePortSettingsRequestDto
      • FleetVesselListResponse
      • VesselFlag
      • LegacyStsPairingsData
      • PositionalDiscrepancyResponse
      • VesselSubscriptionRequestDTO
      • LegacyStsPairing
      • BerthTerminalGroupDto
      • ZoneServiceNavigationalStatus
      • ZonePortSubscriptionRequestDTO
      • LegacyPairedVessel
      • UpdateFleetV2Response
      • StsPairingServiceVesselCharacteristics
      • MaritimeAnalyticsBeErrorResponse
      • FleetSummaryV2
      • FleetDetailResponse
      • GapDto
      • StsPairingServiceDimensions
      • VesselIdentifiers
      • RejectedVessels
      • BerthInformation
      • VesselPositionsGroup
      • SubscriptionSingleResponseDTO
      • VesselResultsSummary
      • LatestVesselPositionItem
      • OccupancyPaginationDto
      • SubscriptionsResponseDTO
      • SubscriptionIdsRequestDTO
      • VesselEntryDetails
      • PortAnalyticsDataEntry
      • LatestPositionDetails
      • LatestPositionsResponse
      • FleetSummaryV2Update
      • PortAnalyticsMeta
      • VesselResultsDetail
      • ZonePortVessel
      • BerthEvent
      • VoyagePortCall
      • VoyagePortZoneEvent
      • PortDwellSeriesEntryDto
      • PortInfoDto
      • TopVesselDto
      • VesselVisitDto
      • ZoneAnalyticsDataEntry
      • ZoneAnalyticsMeta
      • ZoneAnalyticsTotals
      • ZoneInfoDto

    BerthEventsResponse

    Envelope for the berth-traffic operation. Note port_information is an array here, unlike every other envelope, where the descriptive block is a single object.

    {
        "meta": {
            "limit": 100,
            "offset": 0,
            "total_count": 2,
            "request_id": "5c2e8a74-91bf-4d33-8a6c-71e0d4b9f2a5",
            "request_timestamp": "2024-01-12T10:12:24Z",
            "zone_version": "string"
        },
        "data": {
            "port_information": [
                {
                    "id": "4770",
                    "name": "Starigrad",
                    "type": "Ports",
                    "sub_type": "CRA",
                    "description": "",
                    "centroid": {
                        "longitude": 16.4419,
                        "latitude": 43.1875
                    },
                    "country_code": "HRV",
                    "country_common_name": "Croatia",
                    "country_official_name": "Republic of Croatia",
                    "sub_division_code": "string",
                    "sub_division_name": "string",
                    "unlocode": "HRSGR",
                    "wpi_number": 0,
                    "custom_zone_details": {
                        "custom_type": "CIRCULAR",
                        "name": "Zone A",
                        "description": "A polygon zone",
                        "created_by": "string",
                        "created_at": "string",
                        "last_modified_by": "string",
                        "last_modified_at": "string",
                        "circle_details": {
                            "latitude": 25.363052,
                            "longitude": 55.375141,
                            "radius": 1000
                        },
                        "polygon_details": {
                            "format": "WKT",
                            "polygon": "string"
                        }
                    }
                }
            ],
            "events": [
                {
                    "event_details": {
                        "event_id": "string",
                        "event_type": "BERTH_ARRIVAL",
                        "event_timestamp": "2024-01-12T10:12:24",
                        "latitude": 0,
                        "longitude": 0,
                        "speed": 0,
                        "course": 0,
                        "heading": 0,
                        "draught": 0,
                        "navigational_status": {
                            "code": 0,
                            "status": "UNDER_WAY_USING_ENGINE"
                        },
                        "reported_destination": "string",
                        "reported_eta": "string"
                    },
                    "vessel_information": {
                        "asset_id": "c019c3b9-2016-46f0-8f6d-db6d12e37c43",
                        "imo": "9345212",
                        "mmsi": "string",
                        "name": "SOOLY",
                        "callsign": "string",
                        "flag": "India",
                        "flag_code": "IND",
                        "vessel_type": "FISHING SHIP"
                    },
                    "berth_information": {
                        "id": "string",
                        "name": "string",
                        "port_id": "string"
                    }
                }
            ]
        }
    }
    Built with