Skip to main content

Interface: IDcsaTransportSubscriptionBody

Transport subscription filters.

Source: transportSubscriptionBody schema in the DCSA Event Domain (v3.1.0).

See​

https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/event/event_domain_v3.1.0.yaml

Extends​

Properties​

transportCallReference?​

optional transportCallReference: string

Filters to only receive events for a specific transport call.

Inherited from​

IDcsaTransportCallSubscriptionBody.transportCallReference

vesselIMONumber?​

optional vesselIMONumber: string

Filters to only receive events for a specific vessel IMO number.

Inherited from​

IDcsaTransportCallSubscriptionBody.vesselIMONumber

carrierExportVoyageNumber?​

optional carrierExportVoyageNumber: string

Filters to only receive events for a specific carrier export voyage number.

Inherited from​

IDcsaTransportCallSubscriptionBody.carrierExportVoyageNumber

universalExportVoyageReference?​

optional universalExportVoyageReference: string

Filters to only receive events for a specific universal export voyage reference.

Inherited from​

IDcsaTransportCallSubscriptionBody.universalExportVoyageReference

carrierServiceCode?​

optional carrierServiceCode: string

Filters to only receive events for a specific carrier service code.

Inherited from​

IDcsaTransportCallSubscriptionBody.carrierServiceCode

universalServiceReference?​

optional universalServiceReference: string

Filters to only receive events for a specific universal service reference.

Inherited from​

IDcsaTransportCallSubscriptionBody.universalServiceReference

UNLocationCode?​

optional UNLocationCode: string

Filters to only receive events for a specific UN/LOCODE.

Inherited from​

IDcsaTransportCallSubscriptionBody.UNLocationCode

transportEventTypeCodes?​

optional transportEventTypeCodes: DcsaTransportEventTypeCodes[]

Transport event type codes to filter by.