Documentation
¶
Overview ¶
Package vesselapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.
Package vesselapi provides a Go client for the Vessel Tracking API.
Usage:
client, err := vesselapi.NewVesselClient("your-api-key")
if err != nil {
log.Fatal(err)
}
vessel, err := client.Vessels.Get(ctx, "9363728", nil)
Index ¶
- Constants
- func Deref[T any](p *T) T
- func NewGetEmissionsRequest(server string, params *GetEmissionsParams) (*http.Request, error)
- func NewGetLocationDgpsBoundingBoxRequest(server string, params *GetLocationDgpsBoundingBoxParams) (*http.Request, error)
- func NewGetLocationDgpsRadiusRequest(server string, params *GetLocationDgpsRadiusParams) (*http.Request, error)
- func NewGetLocationLightaidsBoundingBoxRequest(server string, params *GetLocationLightaidsBoundingBoxParams) (*http.Request, error)
- func NewGetLocationLightaidsRadiusRequest(server string, params *GetLocationLightaidsRadiusParams) (*http.Request, error)
- func NewGetLocationModuBoundingBoxRequest(server string, params *GetLocationModuBoundingBoxParams) (*http.Request, error)
- func NewGetLocationModuRadiusRequest(server string, params *GetLocationModuRadiusParams) (*http.Request, error)
- func NewGetLocationPortsBoundingBoxRequest(server string, params *GetLocationPortsBoundingBoxParams) (*http.Request, error)
- func NewGetLocationPortsRadiusRequest(server string, params *GetLocationPortsRadiusParams) (*http.Request, error)
- func NewGetLocationRadiobeaconsBoundingBoxRequest(server string, params *GetLocationRadiobeaconsBoundingBoxParams) (*http.Request, error)
- func NewGetLocationRadiobeaconsRadiusRequest(server string, params *GetLocationRadiobeaconsRadiusParams) (*http.Request, error)
- func NewGetLocationVesselsBoundingBoxRequest(server string, params *GetLocationVesselsBoundingBoxParams) (*http.Request, error)
- func NewGetLocationVesselsRadiusRequest(server string, params *GetLocationVesselsRadiusParams) (*http.Request, error)
- func NewGetNavtexRequest(server string, params *GetNavtexParams) (*http.Request, error)
- func NewGetPortUnlocodeRequest(server string, unlocode string) (*http.Request, error)
- func NewGetPorteventsPortUnlocodeRequest(server string, unlocode string, params *GetPorteventsPortUnlocodeParams) (*http.Request, error)
- func NewGetPorteventsPortsRequest(server string, params *GetPorteventsPortsParams) (*http.Request, error)
- func NewGetPorteventsRequest(server string, params *GetPorteventsParams) (*http.Request, error)
- func NewGetPorteventsVesselIdLastRequest(server string, id string, params *GetPorteventsVesselIdLastParams) (*http.Request, error)
- func NewGetPorteventsVesselIdRequest(server string, id string, params *GetPorteventsVesselIdParams) (*http.Request, error)
- func NewGetPorteventsVesselsRequest(server string, params *GetPorteventsVesselsParams) (*http.Request, error)
- func NewGetSearchDgpsRequest(server string, params *GetSearchDgpsParams) (*http.Request, error)
- func NewGetSearchLightaidsRequest(server string, params *GetSearchLightaidsParams) (*http.Request, error)
- func NewGetSearchModusRequest(server string, params *GetSearchModusParams) (*http.Request, error)
- func NewGetSearchPortsRequest(server string, params *GetSearchPortsParams) (*http.Request, error)
- func NewGetSearchRadiobeaconsRequest(server string, params *GetSearchRadiobeaconsParams) (*http.Request, error)
- func NewGetSearchVesselsRequest(server string, params *GetSearchVesselsParams) (*http.Request, error)
- func NewGetVesselIdCasualtiesRequest(server string, id string, params *GetVesselIdCasualtiesParams) (*http.Request, error)
- func NewGetVesselIdClassificationRequest(server string, id string, params *GetVesselIdClassificationParams) (*http.Request, error)
- func NewGetVesselIdEmissionsRequest(server string, id string, params *GetVesselIdEmissionsParams) (*http.Request, error)
- func NewGetVesselIdEtaRequest(server string, id string, params *GetVesselIdEtaParams) (*http.Request, error)
- func NewGetVesselIdInspectionsDetailIdRequest(server string, id string, detailId string, ...) (*http.Request, error)
- func NewGetVesselIdInspectionsRequest(server string, id string, params *GetVesselIdInspectionsParams) (*http.Request, error)
- func NewGetVesselIdOwnershipRequest(server string, id string, params *GetVesselIdOwnershipParams) (*http.Request, error)
- func NewGetVesselIdPositionRequest(server string, id string, params *GetVesselIdPositionParams) (*http.Request, error)
- func NewGetVesselIdRequest(server string, id string, params *GetVesselIdParams) (*http.Request, error)
- func NewGetVesselsPositionsRequest(server string, params *GetVesselsPositionsParams) (*http.Request, error)
- func Ptr[T any](v T) *T
- type APIError
- type AuthenticationErrorDetail
- type AuthenticationErrorResponse
- type BadRequestErrorDetail
- type BadRequestErrorResponse
- type ClassificationResponse
- type ClassificationVessel
- type Client
- func (c *Client) GetEmissions(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetLocationDgpsBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, ...) (*http.Response, error)
- func (c *Client) GetLocationDgpsRadius(ctx context.Context, params *GetLocationDgpsRadiusParams, ...) (*http.Response, error)
- func (c *Client) GetLocationLightaidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, ...) (*http.Response, error)
- func (c *Client) GetLocationLightaidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams, ...) (*http.Response, error)
- func (c *Client) GetLocationModuBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams, ...) (*http.Response, error)
- func (c *Client) GetLocationModuRadius(ctx context.Context, params *GetLocationModuRadiusParams, ...) (*http.Response, error)
- func (c *Client) GetLocationPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams, ...) (*http.Response, error)
- func (c *Client) GetLocationPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams, ...) (*http.Response, error)
- func (c *Client) GetLocationRadiobeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, ...) (*http.Response, error)
- func (c *Client) GetLocationRadiobeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, ...) (*http.Response, error)
- func (c *Client) GetLocationVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, ...) (*http.Response, error)
- func (c *Client) GetLocationVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams, ...) (*http.Response, error)
- func (c *Client) GetNavtex(ctx context.Context, params *GetNavtexParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetPortUnlocode(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetPortevents(ctx context.Context, params *GetPorteventsParams, ...) (*http.Response, error)
- func (c *Client) GetPorteventsPortUnlocode(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, ...) (*http.Response, error)
- func (c *Client) GetPorteventsPorts(ctx context.Context, params *GetPorteventsPortsParams, ...) (*http.Response, error)
- func (c *Client) GetPorteventsVesselId(ctx context.Context, id string, params *GetPorteventsVesselIdParams, ...) (*http.Response, error)
- func (c *Client) GetPorteventsVesselIdLast(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, ...) (*http.Response, error)
- func (c *Client) GetPorteventsVessels(ctx context.Context, params *GetPorteventsVesselsParams, ...) (*http.Response, error)
- func (c *Client) GetSearchDgps(ctx context.Context, params *GetSearchDgpsParams, ...) (*http.Response, error)
- func (c *Client) GetSearchLightaids(ctx context.Context, params *GetSearchLightaidsParams, ...) (*http.Response, error)
- func (c *Client) GetSearchModus(ctx context.Context, params *GetSearchModusParams, ...) (*http.Response, error)
- func (c *Client) GetSearchPorts(ctx context.Context, params *GetSearchPortsParams, ...) (*http.Response, error)
- func (c *Client) GetSearchRadiobeacons(ctx context.Context, params *GetSearchRadiobeaconsParams, ...) (*http.Response, error)
- func (c *Client) GetSearchVessels(ctx context.Context, params *GetSearchVesselsParams, ...) (*http.Response, error)
- func (c *Client) GetVesselId(ctx context.Context, id string, params *GetVesselIdParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdClassification(ctx context.Context, id string, params *GetVesselIdClassificationParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdEta(ctx context.Context, id string, params *GetVesselIdEtaParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdInspections(ctx context.Context, id string, params *GetVesselIdInspectionsParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdInspectionsDetailId(ctx context.Context, id string, detailId string, ...) (*http.Response, error)
- func (c *Client) GetVesselIdOwnership(ctx context.Context, id string, params *GetVesselIdOwnershipParams, ...) (*http.Response, error)
- func (c *Client) GetVesselIdPosition(ctx context.Context, id string, params *GetVesselIdPositionParams, ...) (*http.Response, error)
- func (c *Client) GetVesselsPositions(ctx context.Context, params *GetVesselsPositionsParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) GetEmissionsWithResponse(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*GetEmissionsResponse, error)
- func (c *ClientWithResponses) GetLocationDgpsBoundingBoxWithResponse(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, ...) (*GetLocationDgpsBoundingBoxResponse, error)
- func (c *ClientWithResponses) GetLocationDgpsRadiusWithResponse(ctx context.Context, params *GetLocationDgpsRadiusParams, ...) (*GetLocationDgpsRadiusResponse, error)
- func (c *ClientWithResponses) GetLocationLightaidsBoundingBoxWithResponse(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, ...) (*GetLocationLightaidsBoundingBoxResponse, error)
- func (c *ClientWithResponses) GetLocationLightaidsRadiusWithResponse(ctx context.Context, params *GetLocationLightaidsRadiusParams, ...) (*GetLocationLightaidsRadiusResponse, error)
- func (c *ClientWithResponses) GetLocationModuBoundingBoxWithResponse(ctx context.Context, params *GetLocationModuBoundingBoxParams, ...) (*GetLocationModuBoundingBoxResponse, error)
- func (c *ClientWithResponses) GetLocationModuRadiusWithResponse(ctx context.Context, params *GetLocationModuRadiusParams, ...) (*GetLocationModuRadiusResponse, error)
- func (c *ClientWithResponses) GetLocationPortsBoundingBoxWithResponse(ctx context.Context, params *GetLocationPortsBoundingBoxParams, ...) (*GetLocationPortsBoundingBoxResponse, error)
- func (c *ClientWithResponses) GetLocationPortsRadiusWithResponse(ctx context.Context, params *GetLocationPortsRadiusParams, ...) (*GetLocationPortsRadiusResponse, error)
- func (c *ClientWithResponses) GetLocationRadiobeaconsBoundingBoxWithResponse(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, ...) (*GetLocationRadiobeaconsBoundingBoxResponse, error)
- func (c *ClientWithResponses) GetLocationRadiobeaconsRadiusWithResponse(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, ...) (*GetLocationRadiobeaconsRadiusResponse, error)
- func (c *ClientWithResponses) GetLocationVesselsBoundingBoxWithResponse(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, ...) (*GetLocationVesselsBoundingBoxResponse, error)
- func (c *ClientWithResponses) GetLocationVesselsRadiusWithResponse(ctx context.Context, params *GetLocationVesselsRadiusParams, ...) (*GetLocationVesselsRadiusResponse, error)
- func (c *ClientWithResponses) GetNavtexWithResponse(ctx context.Context, params *GetNavtexParams, reqEditors ...RequestEditorFn) (*GetNavtexResponse, error)
- func (c *ClientWithResponses) GetPortUnlocodeWithResponse(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*GetPortUnlocodeResponse, error)
- func (c *ClientWithResponses) GetPorteventsPortUnlocodeWithResponse(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, ...) (*GetPorteventsPortUnlocodeResponse, error)
- func (c *ClientWithResponses) GetPorteventsPortsWithResponse(ctx context.Context, params *GetPorteventsPortsParams, ...) (*GetPorteventsPortsResponse, error)
- func (c *ClientWithResponses) GetPorteventsVesselIdLastWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, ...) (*GetPorteventsVesselIdLastResponse, error)
- func (c *ClientWithResponses) GetPorteventsVesselIdWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdParams, ...) (*GetPorteventsVesselIdResponse, error)
- func (c *ClientWithResponses) GetPorteventsVesselsWithResponse(ctx context.Context, params *GetPorteventsVesselsParams, ...) (*GetPorteventsVesselsResponse, error)
- func (c *ClientWithResponses) GetPorteventsWithResponse(ctx context.Context, params *GetPorteventsParams, ...) (*GetPorteventsResponse, error)
- func (c *ClientWithResponses) GetSearchDgpsWithResponse(ctx context.Context, params *GetSearchDgpsParams, ...) (*GetSearchDgpsResponse, error)
- func (c *ClientWithResponses) GetSearchLightaidsWithResponse(ctx context.Context, params *GetSearchLightaidsParams, ...) (*GetSearchLightaidsResponse, error)
- func (c *ClientWithResponses) GetSearchModusWithResponse(ctx context.Context, params *GetSearchModusParams, ...) (*GetSearchModusResponse, error)
- func (c *ClientWithResponses) GetSearchPortsWithResponse(ctx context.Context, params *GetSearchPortsParams, ...) (*GetSearchPortsResponse, error)
- func (c *ClientWithResponses) GetSearchRadiobeaconsWithResponse(ctx context.Context, params *GetSearchRadiobeaconsParams, ...) (*GetSearchRadiobeaconsResponse, error)
- func (c *ClientWithResponses) GetSearchVesselsWithResponse(ctx context.Context, params *GetSearchVesselsParams, ...) (*GetSearchVesselsResponse, error)
- func (c *ClientWithResponses) GetVesselIdCasualtiesWithResponse(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, ...) (*GetVesselIdCasualtiesResponse, error)
- func (c *ClientWithResponses) GetVesselIdClassificationWithResponse(ctx context.Context, id string, params *GetVesselIdClassificationParams, ...) (*GetVesselIdClassificationResponse, error)
- func (c *ClientWithResponses) GetVesselIdEmissionsWithResponse(ctx context.Context, id string, params *GetVesselIdEmissionsParams, ...) (*GetVesselIdEmissionsResponse, error)
- func (c *ClientWithResponses) GetVesselIdEtaWithResponse(ctx context.Context, id string, params *GetVesselIdEtaParams, ...) (*GetVesselIdEtaResponse, error)
- func (c *ClientWithResponses) GetVesselIdInspectionsDetailIdWithResponse(ctx context.Context, id string, detailId string, ...) (*GetVesselIdInspectionsDetailIdResponse, error)
- func (c *ClientWithResponses) GetVesselIdInspectionsWithResponse(ctx context.Context, id string, params *GetVesselIdInspectionsParams, ...) (*GetVesselIdInspectionsResponse, error)
- func (c *ClientWithResponses) GetVesselIdOwnershipWithResponse(ctx context.Context, id string, params *GetVesselIdOwnershipParams, ...) (*GetVesselIdOwnershipResponse, error)
- func (c *ClientWithResponses) GetVesselIdPositionWithResponse(ctx context.Context, id string, params *GetVesselIdPositionParams, ...) (*GetVesselIdPositionResponse, error)
- func (c *ClientWithResponses) GetVesselIdWithResponse(ctx context.Context, id string, params *GetVesselIdParams, ...) (*GetVesselIdResponse, error)
- func (c *ClientWithResponses) GetVesselsPositionsWithResponse(ctx context.Context, params *GetVesselsPositionsParams, ...) (*GetVesselsPositionsResponse, error)
- type ClientWithResponsesInterface
- type DGPSStation
- type DGPSStationsWithinLocationResponse
- type EmissionsService
- type ErrorCode
- type ErrorType
- type FindDGPSStationsResponse
- type FindLightAidsResponse
- type FindMODUsResponse
- type FindPortsResponse
- type FindRadioBeaconsResponse
- type FindVesselsResponse
- type GetEmissionsParams
- type GetEmissionsResponse
- type GetLocationDgpsBoundingBoxParams
- type GetLocationDgpsBoundingBoxResponse
- type GetLocationDgpsRadiusParams
- type GetLocationDgpsRadiusResponse
- type GetLocationLightaidsBoundingBoxParams
- type GetLocationLightaidsBoundingBoxResponse
- type GetLocationLightaidsRadiusParams
- type GetLocationLightaidsRadiusResponse
- type GetLocationModuBoundingBoxParams
- type GetLocationModuBoundingBoxResponse
- type GetLocationModuRadiusParams
- type GetLocationModuRadiusResponse
- type GetLocationPortsBoundingBoxParams
- type GetLocationPortsBoundingBoxResponse
- type GetLocationPortsRadiusParams
- type GetLocationPortsRadiusResponse
- type GetLocationRadiobeaconsBoundingBoxParams
- type GetLocationRadiobeaconsBoundingBoxResponse
- type GetLocationRadiobeaconsRadiusParams
- type GetLocationRadiobeaconsRadiusResponse
- type GetLocationVesselsBoundingBoxParams
- type GetLocationVesselsBoundingBoxResponse
- type GetLocationVesselsRadiusParams
- type GetLocationVesselsRadiusResponse
- type GetNavtexParams
- type GetNavtexResponse
- type GetPortUnlocodeResponse
- type GetPorteventsParams
- type GetPorteventsPortUnlocodeParams
- type GetPorteventsPortUnlocodeResponse
- type GetPorteventsPortsParams
- type GetPorteventsPortsResponse
- type GetPorteventsResponse
- type GetPorteventsVesselIdLastParams
- type GetPorteventsVesselIdLastParamsFilterIdType
- type GetPorteventsVesselIdLastResponse
- type GetPorteventsVesselIdParams
- type GetPorteventsVesselIdParamsFilterEventType
- type GetPorteventsVesselIdParamsFilterIdType
- type GetPorteventsVesselIdParamsFilterSortOrder
- type GetPorteventsVesselIdResponse
- type GetPorteventsVesselsParams
- type GetPorteventsVesselsResponse
- type GetSearchDgpsParams
- type GetSearchDgpsResponse
- type GetSearchLightaidsParams
- type GetSearchLightaidsResponse
- type GetSearchModusParams
- type GetSearchModusResponse
- type GetSearchPortsParams
- type GetSearchPortsResponse
- type GetSearchRadiobeaconsParams
- type GetSearchRadiobeaconsResponse
- type GetSearchVesselsParams
- type GetSearchVesselsResponse
- type GetVesselIdCasualtiesParams
- type GetVesselIdCasualtiesParamsFilterIdType
- type GetVesselIdCasualtiesResponse
- type GetVesselIdClassificationParams
- type GetVesselIdClassificationParamsFilterIdType
- type GetVesselIdClassificationResponse
- type GetVesselIdEmissionsParams
- type GetVesselIdEmissionsParamsFilterIdType
- type GetVesselIdEmissionsResponse
- type GetVesselIdEtaParams
- type GetVesselIdEtaParamsFilterIdType
- type GetVesselIdEtaResponse
- type GetVesselIdInspectionsDetailIdParams
- type GetVesselIdInspectionsDetailIdParamsFilterIdType
- type GetVesselIdInspectionsDetailIdResponse
- type GetVesselIdInspectionsParams
- type GetVesselIdInspectionsParamsFilterIdType
- type GetVesselIdInspectionsResponse
- type GetVesselIdOwnershipParams
- type GetVesselIdOwnershipParamsFilterIdType
- type GetVesselIdOwnershipResponse
- type GetVesselIdParams
- type GetVesselIdParamsFilterIdType
- type GetVesselIdPositionParams
- type GetVesselIdPositionParamsFilterIdType
- type GetVesselIdPositionResponse
- type GetVesselIdResponse
- type GetVesselsPositionsParams
- type GetVesselsPositionsParamsFilterIdType
- type GetVesselsPositionsResponse
- type GithubComVesselapiCommonVesselDataContractsTypesBroadcastStation
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationCertificate
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationCondition
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationDimensions
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationHull
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationIdentification
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationInfo
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationMachinery
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationOwner
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationPurpose
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationSurvey
- type GithubComVesselapiCommonVesselDataContractsTypesClassificationYard
- type GithubComVesselapiCommonVesselDataContractsTypesGeoJSON
- type GithubComVesselapiCommonVesselDataContractsTypesPortCountry
- type GithubComVesselapiCommonVesselDataContractsTypesPortReference
- type GithubComVesselapiCommonVesselDataContractsTypesVesselFormerName
- type GithubComVesselapiCommonVesselDataContractsTypesVesselReference
- type HttpRequestDoer
- type InternalServerErrorDetail
- type InternalServerErrorResponse
- type Iterator
- type LightAid
- type LightAidsWithinLocationResponse
- type LocationService
- func (s *LocationService) AllDGPSBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams) *Iterator[DGPSStation]
- func (s *LocationService) AllDGPSRadius(ctx context.Context, params *GetLocationDgpsRadiusParams) *Iterator[DGPSStation]
- func (s *LocationService) AllLightAidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams) *Iterator[LightAid]
- func (s *LocationService) AllLightAidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams) *Iterator[LightAid]
- func (s *LocationService) AllMODUsBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams) *Iterator[MODU]
- func (s *LocationService) AllMODUsRadius(ctx context.Context, params *GetLocationModuRadiusParams) *Iterator[MODU]
- func (s *LocationService) AllPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams) *Iterator[Port]
- func (s *LocationService) AllPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams) *Iterator[Port]
- func (s *LocationService) AllRadioBeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams) *Iterator[RadioBeacon]
- func (s *LocationService) AllRadioBeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams) *Iterator[RadioBeacon]
- func (s *LocationService) AllVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams) *Iterator[VesselPosition]
- func (s *LocationService) AllVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams) *Iterator[VesselPosition]
- func (s *LocationService) DGPSBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams) (*DGPSStationsWithinLocationResponse, error)
- func (s *LocationService) DGPSRadius(ctx context.Context, params *GetLocationDgpsRadiusParams) (*DGPSStationsWithinLocationResponse, error)
- func (s *LocationService) LightAidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams) (*LightAidsWithinLocationResponse, error)
- func (s *LocationService) LightAidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams) (*LightAidsWithinLocationResponse, error)
- func (s *LocationService) MODUsBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams) (*MODUsWithinLocationResponse, error)
- func (s *LocationService) MODUsRadius(ctx context.Context, params *GetLocationModuRadiusParams) (*MODUsWithinLocationResponse, error)
- func (s *LocationService) PortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams) (*PortsWithinLocationResponse, error)
- func (s *LocationService) PortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams) (*PortsWithinLocationResponse, error)
- func (s *LocationService) RadioBeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams) (*RadioBeaconsWithinLocationResponse, error)
- func (s *LocationService) RadioBeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams) (*RadioBeaconsWithinLocationResponse, error)
- func (s *LocationService) VesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams) (*VesselsWithinLocationResponse, error)
- func (s *LocationService) VesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams) (*VesselsWithinLocationResponse, error)
- type MODU
- type MODUsWithinLocationResponse
- type MarineCasualtiesResponse
- type MarineCasualty
- type Navtex
- type NavtexMessagesResponse
- type NavtexService
- type NotFoundErrorDetail
- type NotFoundErrorResponse
- type Port
- type PortEvent
- type PortEventResponse
- type PortEventsResponse
- type PortEventsService
- func (s *PortEventsService) AllByPort(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams) *Iterator[PortEvent]
- func (s *PortEventsService) AllByPorts(ctx context.Context, params *GetPorteventsPortsParams) *Iterator[PortEvent]
- func (s *PortEventsService) AllByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdParams) *Iterator[PortEvent]
- func (s *PortEventsService) AllByVessels(ctx context.Context, params *GetPorteventsVesselsParams) *Iterator[PortEvent]
- func (s *PortEventsService) ByPort(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams) (*PortEventsResponse, error)
- func (s *PortEventsService) ByPorts(ctx context.Context, params *GetPorteventsPortsParams) (*PortEventsResponse, error)
- func (s *PortEventsService) ByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdParams) (*PortEventsResponse, error)
- func (s *PortEventsService) ByVessels(ctx context.Context, params *GetPorteventsVesselsParams) (*PortEventsResponse, error)
- func (s *PortEventsService) LastByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams) (*PortEventResponse, error)
- func (s *PortEventsService) List(ctx context.Context, params *GetPorteventsParams) (*PortEventsResponse, error)
- func (s *PortEventsService) ListAll(ctx context.Context, params *GetPorteventsParams) *Iterator[PortEvent]
- type PortResponse
- type PortsService
- type PortsWithinLocationResponse
- type RadioBeacon
- type RadioBeaconsWithinLocationResponse
- type RateLimitErrorDetail
- type RateLimitErrorResponse
- type RequestEditorFn
- type SearchService
- func (s *SearchService) AllDGPS(ctx context.Context, params *GetSearchDgpsParams) *Iterator[DGPSStation]
- func (s *SearchService) AllLightAids(ctx context.Context, params *GetSearchLightaidsParams) *Iterator[LightAid]
- func (s *SearchService) AllMODUs(ctx context.Context, params *GetSearchModusParams) *Iterator[MODU]
- func (s *SearchService) AllPorts(ctx context.Context, params *GetSearchPortsParams) *Iterator[Port]
- func (s *SearchService) AllRadioBeacons(ctx context.Context, params *GetSearchRadiobeaconsParams) *Iterator[RadioBeacon]
- func (s *SearchService) AllVessels(ctx context.Context, params *GetSearchVesselsParams) *Iterator[Vessel]
- func (s *SearchService) DGPS(ctx context.Context, params *GetSearchDgpsParams) (*FindDGPSStationsResponse, error)
- func (s *SearchService) LightAids(ctx context.Context, params *GetSearchLightaidsParams) (*FindLightAidsResponse, error)
- func (s *SearchService) MODUs(ctx context.Context, params *GetSearchModusParams) (*FindMODUsResponse, error)
- func (s *SearchService) Ports(ctx context.Context, params *GetSearchPortsParams) (*FindPortsResponse, error)
- func (s *SearchService) RadioBeacons(ctx context.Context, params *GetSearchRadiobeaconsParams) (*FindRadioBeaconsResponse, error)
- func (s *SearchService) Vessels(ctx context.Context, params *GetSearchVesselsParams) (*FindVesselsResponse, error)
- type TypesInspection
- type TypesInspectionDeficiency
- type TypesInspectionDetail
- type TypesInspectionDetailResponse
- type TypesInspectionsResponse
- type TypesOwnershipResponse
- type TypesVesselOwnership
- type Vessel
- type VesselClient
- type VesselClientOption
- type VesselETA
- type VesselETAResponse
- type VesselEmission
- type VesselEmissionsResponse
- type VesselPosition
- type VesselPositionResponse
- type VesselPositionsResponse
- type VesselResponse
- type VesselsService
- func (s *VesselsService) AllCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams) *Iterator[MarineCasualty]
- func (s *VesselsService) AllEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams) *Iterator[VesselEmission]
- func (s *VesselsService) AllPositions(ctx context.Context, params *GetVesselsPositionsParams) *Iterator[VesselPosition]
- func (s *VesselsService) Casualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams) (*MarineCasualtiesResponse, error)
- func (s *VesselsService) Classification(ctx context.Context, id string, params *GetVesselIdClassificationParams) (*ClassificationResponse, error)
- func (s *VesselsService) ETA(ctx context.Context, id string, params *GetVesselIdEtaParams) (*VesselETAResponse, error)
- func (s *VesselsService) Emissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams) (*VesselEmissionsResponse, error)
- func (s *VesselsService) Get(ctx context.Context, id string, params *GetVesselIdParams) (*VesselResponse, error)
- func (s *VesselsService) InspectionDetail(ctx context.Context, id, detailId string, ...) (*TypesInspectionDetailResponse, error)
- func (s *VesselsService) Inspections(ctx context.Context, id string, params *GetVesselIdInspectionsParams) (*TypesInspectionsResponse, error)
- func (s *VesselsService) Ownership(ctx context.Context, id string, params *GetVesselIdOwnershipParams) (*TypesOwnershipResponse, error)
- func (s *VesselsService) Position(ctx context.Context, id string, params *GetVesselIdPositionParams) (*VesselPositionResponse, error)
- func (s *VesselsService) Positions(ctx context.Context, params *GetVesselsPositionsParams) (*VesselPositionsResponse, error)
- type VesselsWithinLocationResponse
Constants ¶
const ( // Version is the SDK version string. Version = "1.0.0" // DefaultBaseURL is the default Vessel API base URL. DefaultBaseURL = "https://api.vesselapi.com/v1" // DefaultUserAgent is the default User-Agent header value. DefaultUserAgent = "vesselapi-go/" + Version )
const (
ApiKeyAuthScopes = "ApiKeyAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func Deref ¶
func Deref[T any](p *T) T
Deref safely dereferences a pointer. Returns the zero value of T if p is nil.
func NewGetEmissionsRequest ¶
func NewGetEmissionsRequest(server string, params *GetEmissionsParams) (*http.Request, error)
NewGetEmissionsRequest generates requests for GetEmissions
func NewGetLocationDgpsBoundingBoxRequest ¶
func NewGetLocationDgpsBoundingBoxRequest(server string, params *GetLocationDgpsBoundingBoxParams) (*http.Request, error)
NewGetLocationDgpsBoundingBoxRequest generates requests for GetLocationDgpsBoundingBox
func NewGetLocationDgpsRadiusRequest ¶
func NewGetLocationDgpsRadiusRequest(server string, params *GetLocationDgpsRadiusParams) (*http.Request, error)
NewGetLocationDgpsRadiusRequest generates requests for GetLocationDgpsRadius
func NewGetLocationLightaidsBoundingBoxRequest ¶
func NewGetLocationLightaidsBoundingBoxRequest(server string, params *GetLocationLightaidsBoundingBoxParams) (*http.Request, error)
NewGetLocationLightaidsBoundingBoxRequest generates requests for GetLocationLightaidsBoundingBox
func NewGetLocationLightaidsRadiusRequest ¶
func NewGetLocationLightaidsRadiusRequest(server string, params *GetLocationLightaidsRadiusParams) (*http.Request, error)
NewGetLocationLightaidsRadiusRequest generates requests for GetLocationLightaidsRadius
func NewGetLocationModuBoundingBoxRequest ¶
func NewGetLocationModuBoundingBoxRequest(server string, params *GetLocationModuBoundingBoxParams) (*http.Request, error)
NewGetLocationModuBoundingBoxRequest generates requests for GetLocationModuBoundingBox
func NewGetLocationModuRadiusRequest ¶
func NewGetLocationModuRadiusRequest(server string, params *GetLocationModuRadiusParams) (*http.Request, error)
NewGetLocationModuRadiusRequest generates requests for GetLocationModuRadius
func NewGetLocationPortsBoundingBoxRequest ¶
func NewGetLocationPortsBoundingBoxRequest(server string, params *GetLocationPortsBoundingBoxParams) (*http.Request, error)
NewGetLocationPortsBoundingBoxRequest generates requests for GetLocationPortsBoundingBox
func NewGetLocationPortsRadiusRequest ¶
func NewGetLocationPortsRadiusRequest(server string, params *GetLocationPortsRadiusParams) (*http.Request, error)
NewGetLocationPortsRadiusRequest generates requests for GetLocationPortsRadius
func NewGetLocationRadiobeaconsBoundingBoxRequest ¶
func NewGetLocationRadiobeaconsBoundingBoxRequest(server string, params *GetLocationRadiobeaconsBoundingBoxParams) (*http.Request, error)
NewGetLocationRadiobeaconsBoundingBoxRequest generates requests for GetLocationRadiobeaconsBoundingBox
func NewGetLocationRadiobeaconsRadiusRequest ¶
func NewGetLocationRadiobeaconsRadiusRequest(server string, params *GetLocationRadiobeaconsRadiusParams) (*http.Request, error)
NewGetLocationRadiobeaconsRadiusRequest generates requests for GetLocationRadiobeaconsRadius
func NewGetLocationVesselsBoundingBoxRequest ¶
func NewGetLocationVesselsBoundingBoxRequest(server string, params *GetLocationVesselsBoundingBoxParams) (*http.Request, error)
NewGetLocationVesselsBoundingBoxRequest generates requests for GetLocationVesselsBoundingBox
func NewGetLocationVesselsRadiusRequest ¶
func NewGetLocationVesselsRadiusRequest(server string, params *GetLocationVesselsRadiusParams) (*http.Request, error)
NewGetLocationVesselsRadiusRequest generates requests for GetLocationVesselsRadius
func NewGetNavtexRequest ¶
func NewGetNavtexRequest(server string, params *GetNavtexParams) (*http.Request, error)
NewGetNavtexRequest generates requests for GetNavtex
func NewGetPortUnlocodeRequest ¶
NewGetPortUnlocodeRequest generates requests for GetPortUnlocode
func NewGetPorteventsPortUnlocodeRequest ¶
func NewGetPorteventsPortUnlocodeRequest(server string, unlocode string, params *GetPorteventsPortUnlocodeParams) (*http.Request, error)
NewGetPorteventsPortUnlocodeRequest generates requests for GetPorteventsPortUnlocode
func NewGetPorteventsPortsRequest ¶
func NewGetPorteventsPortsRequest(server string, params *GetPorteventsPortsParams) (*http.Request, error)
NewGetPorteventsPortsRequest generates requests for GetPorteventsPorts
func NewGetPorteventsRequest ¶
func NewGetPorteventsRequest(server string, params *GetPorteventsParams) (*http.Request, error)
NewGetPorteventsRequest generates requests for GetPortevents
func NewGetPorteventsVesselIdLastRequest ¶
func NewGetPorteventsVesselIdLastRequest(server string, id string, params *GetPorteventsVesselIdLastParams) (*http.Request, error)
NewGetPorteventsVesselIdLastRequest generates requests for GetPorteventsVesselIdLast
func NewGetPorteventsVesselIdRequest ¶
func NewGetPorteventsVesselIdRequest(server string, id string, params *GetPorteventsVesselIdParams) (*http.Request, error)
NewGetPorteventsVesselIdRequest generates requests for GetPorteventsVesselId
func NewGetPorteventsVesselsRequest ¶
func NewGetPorteventsVesselsRequest(server string, params *GetPorteventsVesselsParams) (*http.Request, error)
NewGetPorteventsVesselsRequest generates requests for GetPorteventsVessels
func NewGetSearchDgpsRequest ¶
func NewGetSearchDgpsRequest(server string, params *GetSearchDgpsParams) (*http.Request, error)
NewGetSearchDgpsRequest generates requests for GetSearchDgps
func NewGetSearchLightaidsRequest ¶
func NewGetSearchLightaidsRequest(server string, params *GetSearchLightaidsParams) (*http.Request, error)
NewGetSearchLightaidsRequest generates requests for GetSearchLightaids
func NewGetSearchModusRequest ¶
func NewGetSearchModusRequest(server string, params *GetSearchModusParams) (*http.Request, error)
NewGetSearchModusRequest generates requests for GetSearchModus
func NewGetSearchPortsRequest ¶
func NewGetSearchPortsRequest(server string, params *GetSearchPortsParams) (*http.Request, error)
NewGetSearchPortsRequest generates requests for GetSearchPorts
func NewGetSearchRadiobeaconsRequest ¶
func NewGetSearchRadiobeaconsRequest(server string, params *GetSearchRadiobeaconsParams) (*http.Request, error)
NewGetSearchRadiobeaconsRequest generates requests for GetSearchRadiobeacons
func NewGetSearchVesselsRequest ¶
func NewGetSearchVesselsRequest(server string, params *GetSearchVesselsParams) (*http.Request, error)
NewGetSearchVesselsRequest generates requests for GetSearchVessels
func NewGetVesselIdCasualtiesRequest ¶
func NewGetVesselIdCasualtiesRequest(server string, id string, params *GetVesselIdCasualtiesParams) (*http.Request, error)
NewGetVesselIdCasualtiesRequest generates requests for GetVesselIdCasualties
func NewGetVesselIdClassificationRequest ¶
func NewGetVesselIdClassificationRequest(server string, id string, params *GetVesselIdClassificationParams) (*http.Request, error)
NewGetVesselIdClassificationRequest generates requests for GetVesselIdClassification
func NewGetVesselIdEmissionsRequest ¶
func NewGetVesselIdEmissionsRequest(server string, id string, params *GetVesselIdEmissionsParams) (*http.Request, error)
NewGetVesselIdEmissionsRequest generates requests for GetVesselIdEmissions
func NewGetVesselIdEtaRequest ¶
func NewGetVesselIdEtaRequest(server string, id string, params *GetVesselIdEtaParams) (*http.Request, error)
NewGetVesselIdEtaRequest generates requests for GetVesselIdEta
func NewGetVesselIdInspectionsDetailIdRequest ¶
func NewGetVesselIdInspectionsDetailIdRequest(server string, id string, detailId string, params *GetVesselIdInspectionsDetailIdParams) (*http.Request, error)
NewGetVesselIdInspectionsDetailIdRequest generates requests for GetVesselIdInspectionsDetailId
func NewGetVesselIdInspectionsRequest ¶
func NewGetVesselIdInspectionsRequest(server string, id string, params *GetVesselIdInspectionsParams) (*http.Request, error)
NewGetVesselIdInspectionsRequest generates requests for GetVesselIdInspections
func NewGetVesselIdOwnershipRequest ¶
func NewGetVesselIdOwnershipRequest(server string, id string, params *GetVesselIdOwnershipParams) (*http.Request, error)
NewGetVesselIdOwnershipRequest generates requests for GetVesselIdOwnership
func NewGetVesselIdPositionRequest ¶
func NewGetVesselIdPositionRequest(server string, id string, params *GetVesselIdPositionParams) (*http.Request, error)
NewGetVesselIdPositionRequest generates requests for GetVesselIdPosition
func NewGetVesselIdRequest ¶
func NewGetVesselIdRequest(server string, id string, params *GetVesselIdParams) (*http.Request, error)
NewGetVesselIdRequest generates requests for GetVesselId
func NewGetVesselsPositionsRequest ¶
func NewGetVesselsPositionsRequest(server string, params *GetVesselsPositionsParams) (*http.Request, error)
NewGetVesselsPositionsRequest generates requests for GetVesselsPositions
Types ¶
type APIError ¶
type APIError struct {
// StatusCode is the HTTP status code.
StatusCode int
// Message is the human-readable error message.
Message string
// Body is the raw response body, available for re-parsing if needed.
Body []byte
}
APIError represents an error response from the Vessel API.
func (*APIError) IsAuthError ¶
IsAuthError returns true if the error is a 401 Unauthorized response.
func (*APIError) IsNotFound ¶
IsNotFound returns true if the error is a 404 Not Found response.
func (*APIError) IsRateLimited ¶
IsRateLimited returns true if the error is a 429 Too Many Requests response.
type AuthenticationErrorDetail ¶
type AuthenticationErrorDetail struct {
// Code is a short string identifier for this error for programmatic handling
Code *ErrorCode `json:"code,omitempty"`
// Message is a human-readable message providing more details about the error
Message *string `json:"message,omitempty"`
// Type categorizes the error (always "authentication_error" for 401s)
Type *ErrorType `json:"type,omitempty"`
}
AuthenticationErrorDetail Detailed authentication error information
type AuthenticationErrorResponse ¶
type AuthenticationErrorResponse struct {
// Error Detailed authentication error information
Error *AuthenticationErrorDetail `json:"error,omitempty"`
}
AuthenticationErrorResponse Response returned when authentication fails (HTTP 401)
type BadRequestErrorDetail ¶
type BadRequestErrorDetail struct {
// Code is a short string identifier for this error for programmatic handling
Code *ErrorCode `json:"code,omitempty"`
// DocUrl DocURL is a link to documentation for more information
DocUrl *string `json:"doc_url,omitempty"`
// Message is a human-readable message providing more details about the error
Message *string `json:"message,omitempty"`
// Param identifies the parameter that caused the error (if applicable)
Param *string `json:"param,omitempty"`
// Type categorizes the error (e.g., "invalid_request_error")
Type *ErrorType `json:"type,omitempty"`
}
BadRequestErrorDetail Detailed bad request error information
type BadRequestErrorResponse ¶
type BadRequestErrorResponse struct {
// Error Detailed bad request error information
Error *BadRequestErrorDetail `json:"error,omitempty"`
}
BadRequestErrorResponse Response returned for invalid requests (HTTP 400)
type ClassificationResponse ¶
type ClassificationResponse struct {
// Classification Vessel classification data including identification, certificates, surveys, and technical specifications
Classification *ClassificationVessel `json:"classification,omitempty"`
}
ClassificationResponse Response containing vessel classification data
type ClassificationVessel ¶
type ClassificationVessel struct {
// Certificates List of vessel certificates
Certificates *[]GithubComVesselapiCommonVesselDataContractsTypesClassificationCertificate `json:"certificates,omitempty"`
// Classification Classification society notation and status information
Classification *GithubComVesselapiCommonVesselDataContractsTypesClassificationInfo `json:"classification,omitempty"`
// CollectedAt UTC timestamp when data was collected
CollectedAt *string `json:"collectedAt,omitempty"`
// Conditions Conditions of class imposed on the vessel
Conditions *[]GithubComVesselapiCommonVesselDataContractsTypesClassificationCondition `json:"conditions,omitempty"`
// Dimensions Vessel dimensional measurements from classification records
Dimensions *GithubComVesselapiCommonVesselDataContractsTypesClassificationDimensions `json:"dimensions,omitempty"`
// Hull Vessel hull construction details
Hull *GithubComVesselapiCommonVesselDataContractsTypesClassificationHull `json:"hull,omitempty"`
// Identification Vessel identification details from classification society records
Identification *GithubComVesselapiCommonVesselDataContractsTypesClassificationIdentification `json:"identification,omitempty"`
// Imo Metadata (set by collector, not from API)
Imo *int `json:"imo,omitempty"`
// Machinery Vessel machinery and propulsion details
Machinery *GithubComVesselapiCommonVesselDataContractsTypesClassificationMachinery `json:"machinery,omitempty"`
// Owner Vessel owner and management company details from classification records
Owner *GithubComVesselapiCommonVesselDataContractsTypesClassificationOwner `json:"owner,omitempty"`
// Surveys Survey records from classification society
Surveys *[]GithubComVesselapiCommonVesselDataContractsTypesClassificationSurvey `json:"surveys,omitempty"`
// Yard Shipyard and construction details from classification records
Yard *GithubComVesselapiCommonVesselDataContractsTypesClassificationYard `json:"yard,omitempty"`
}
ClassificationVessel Vessel classification data including identification, certificates, surveys, and technical specifications
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) GetEmissions ¶
func (c *Client) GetEmissions(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationDgpsBoundingBox ¶
func (c *Client) GetLocationDgpsBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationDgpsRadius ¶
func (c *Client) GetLocationDgpsRadius(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationLightaidsBoundingBox ¶
func (c *Client) GetLocationLightaidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationLightaidsRadius ¶
func (c *Client) GetLocationLightaidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationModuBoundingBox ¶
func (c *Client) GetLocationModuBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationModuRadius ¶
func (c *Client) GetLocationModuRadius(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationPortsBoundingBox ¶
func (c *Client) GetLocationPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationPortsRadius ¶
func (c *Client) GetLocationPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationRadiobeaconsBoundingBox ¶
func (c *Client) GetLocationRadiobeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationRadiobeaconsRadius ¶
func (c *Client) GetLocationRadiobeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationVesselsBoundingBox ¶
func (c *Client) GetLocationVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetLocationVesselsRadius ¶
func (c *Client) GetLocationVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetNavtex ¶
func (c *Client) GetNavtex(ctx context.Context, params *GetNavtexParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetPortUnlocode ¶
func (*Client) GetPortevents ¶
func (c *Client) GetPortevents(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetPorteventsPortUnlocode ¶
func (c *Client) GetPorteventsPortUnlocode(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetPorteventsPorts ¶
func (c *Client) GetPorteventsPorts(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetPorteventsVesselId ¶
func (c *Client) GetPorteventsVesselId(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetPorteventsVesselIdLast ¶
func (c *Client) GetPorteventsVesselIdLast(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetPorteventsVessels ¶
func (c *Client) GetPorteventsVessels(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSearchDgps ¶
func (c *Client) GetSearchDgps(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSearchLightaids ¶
func (c *Client) GetSearchLightaids(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSearchModus ¶
func (c *Client) GetSearchModus(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSearchPorts ¶
func (c *Client) GetSearchPorts(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSearchRadiobeacons ¶
func (c *Client) GetSearchRadiobeacons(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSearchVessels ¶
func (c *Client) GetSearchVessels(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselId ¶
func (c *Client) GetVesselId(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdCasualties ¶
func (c *Client) GetVesselIdCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdClassification ¶
func (c *Client) GetVesselIdClassification(ctx context.Context, id string, params *GetVesselIdClassificationParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdEmissions ¶
func (c *Client) GetVesselIdEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdEta ¶
func (c *Client) GetVesselIdEta(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdInspections ¶
func (c *Client) GetVesselIdInspections(ctx context.Context, id string, params *GetVesselIdInspectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdInspectionsDetailId ¶
func (c *Client) GetVesselIdInspectionsDetailId(ctx context.Context, id string, detailId string, params *GetVesselIdInspectionsDetailIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdOwnership ¶
func (c *Client) GetVesselIdOwnership(ctx context.Context, id string, params *GetVesselIdOwnershipParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselIdPosition ¶
func (c *Client) GetVesselIdPosition(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVesselsPositions ¶
func (c *Client) GetVesselsPositions(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// GetEmissions request
GetEmissions(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationDgpsBoundingBox request
GetLocationDgpsBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationDgpsRadius request
GetLocationDgpsRadius(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationLightaidsBoundingBox request
GetLocationLightaidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationLightaidsRadius request
GetLocationLightaidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationModuBoundingBox request
GetLocationModuBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationModuRadius request
GetLocationModuRadius(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationPortsBoundingBox request
GetLocationPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationPortsRadius request
GetLocationPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationRadiobeaconsBoundingBox request
GetLocationRadiobeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationRadiobeaconsRadius request
GetLocationRadiobeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationVesselsBoundingBox request
GetLocationVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLocationVesselsRadius request
GetLocationVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
GetNavtex(ctx context.Context, params *GetNavtexParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPortUnlocode request
GetPortUnlocode(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPortevents request
GetPortevents(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPorteventsPortUnlocode request
GetPorteventsPortUnlocode(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPorteventsPorts request
GetPorteventsPorts(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPorteventsVesselId request
GetPorteventsVesselId(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPorteventsVesselIdLast request
GetPorteventsVesselIdLast(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPorteventsVessels request
GetPorteventsVessels(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchDgps request
GetSearchDgps(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchLightaids request
GetSearchLightaids(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchModus request
GetSearchModus(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchPorts request
GetSearchPorts(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchRadiobeacons request
GetSearchRadiobeacons(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchVessels request
GetSearchVessels(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselId request
GetVesselId(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdCasualties request
GetVesselIdCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdClassification request
GetVesselIdClassification(ctx context.Context, id string, params *GetVesselIdClassificationParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdEmissions request
GetVesselIdEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdEta request
GetVesselIdEta(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdInspections request
GetVesselIdInspections(ctx context.Context, id string, params *GetVesselIdInspectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdInspectionsDetailId request
GetVesselIdInspectionsDetailId(ctx context.Context, id string, detailId string, params *GetVesselIdInspectionsDetailIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdOwnership request
GetVesselIdOwnership(ctx context.Context, id string, params *GetVesselIdOwnershipParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselIdPosition request
GetVesselIdPosition(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVesselsPositions request
GetVesselsPositions(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetEmissionsWithResponse ¶
func (c *ClientWithResponses) GetEmissionsWithResponse(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*GetEmissionsResponse, error)
GetEmissionsWithResponse request returning *GetEmissionsResponse
func (*ClientWithResponses) GetLocationDgpsBoundingBoxWithResponse ¶
func (c *ClientWithResponses) GetLocationDgpsBoundingBoxWithResponse(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsBoundingBoxResponse, error)
GetLocationDgpsBoundingBoxWithResponse request returning *GetLocationDgpsBoundingBoxResponse
func (*ClientWithResponses) GetLocationDgpsRadiusWithResponse ¶
func (c *ClientWithResponses) GetLocationDgpsRadiusWithResponse(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsRadiusResponse, error)
GetLocationDgpsRadiusWithResponse request returning *GetLocationDgpsRadiusResponse
func (*ClientWithResponses) GetLocationLightaidsBoundingBoxWithResponse ¶
func (c *ClientWithResponses) GetLocationLightaidsBoundingBoxWithResponse(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsBoundingBoxResponse, error)
GetLocationLightaidsBoundingBoxWithResponse request returning *GetLocationLightaidsBoundingBoxResponse
func (*ClientWithResponses) GetLocationLightaidsRadiusWithResponse ¶
func (c *ClientWithResponses) GetLocationLightaidsRadiusWithResponse(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsRadiusResponse, error)
GetLocationLightaidsRadiusWithResponse request returning *GetLocationLightaidsRadiusResponse
func (*ClientWithResponses) GetLocationModuBoundingBoxWithResponse ¶
func (c *ClientWithResponses) GetLocationModuBoundingBoxWithResponse(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationModuBoundingBoxResponse, error)
GetLocationModuBoundingBoxWithResponse request returning *GetLocationModuBoundingBoxResponse
func (*ClientWithResponses) GetLocationModuRadiusWithResponse ¶
func (c *ClientWithResponses) GetLocationModuRadiusWithResponse(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationModuRadiusResponse, error)
GetLocationModuRadiusWithResponse request returning *GetLocationModuRadiusResponse
func (*ClientWithResponses) GetLocationPortsBoundingBoxWithResponse ¶
func (c *ClientWithResponses) GetLocationPortsBoundingBoxWithResponse(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationPortsBoundingBoxResponse, error)
GetLocationPortsBoundingBoxWithResponse request returning *GetLocationPortsBoundingBoxResponse
func (*ClientWithResponses) GetLocationPortsRadiusWithResponse ¶
func (c *ClientWithResponses) GetLocationPortsRadiusWithResponse(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationPortsRadiusResponse, error)
GetLocationPortsRadiusWithResponse request returning *GetLocationPortsRadiusResponse
func (*ClientWithResponses) GetLocationRadiobeaconsBoundingBoxWithResponse ¶
func (c *ClientWithResponses) GetLocationRadiobeaconsBoundingBoxWithResponse(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsBoundingBoxResponse, error)
GetLocationRadiobeaconsBoundingBoxWithResponse request returning *GetLocationRadiobeaconsBoundingBoxResponse
func (*ClientWithResponses) GetLocationRadiobeaconsRadiusWithResponse ¶
func (c *ClientWithResponses) GetLocationRadiobeaconsRadiusWithResponse(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsRadiusResponse, error)
GetLocationRadiobeaconsRadiusWithResponse request returning *GetLocationRadiobeaconsRadiusResponse
func (*ClientWithResponses) GetLocationVesselsBoundingBoxWithResponse ¶
func (c *ClientWithResponses) GetLocationVesselsBoundingBoxWithResponse(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsBoundingBoxResponse, error)
GetLocationVesselsBoundingBoxWithResponse request returning *GetLocationVesselsBoundingBoxResponse
func (*ClientWithResponses) GetLocationVesselsRadiusWithResponse ¶
func (c *ClientWithResponses) GetLocationVesselsRadiusWithResponse(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsRadiusResponse, error)
GetLocationVesselsRadiusWithResponse request returning *GetLocationVesselsRadiusResponse
func (*ClientWithResponses) GetNavtexWithResponse ¶
func (c *ClientWithResponses) GetNavtexWithResponse(ctx context.Context, params *GetNavtexParams, reqEditors ...RequestEditorFn) (*GetNavtexResponse, error)
GetNavtexWithResponse request returning *GetNavtexResponse
func (*ClientWithResponses) GetPortUnlocodeWithResponse ¶
func (c *ClientWithResponses) GetPortUnlocodeWithResponse(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*GetPortUnlocodeResponse, error)
GetPortUnlocodeWithResponse request returning *GetPortUnlocodeResponse
func (*ClientWithResponses) GetPorteventsPortUnlocodeWithResponse ¶
func (c *ClientWithResponses) GetPorteventsPortUnlocodeWithResponse(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortUnlocodeResponse, error)
GetPorteventsPortUnlocodeWithResponse request returning *GetPorteventsPortUnlocodeResponse
func (*ClientWithResponses) GetPorteventsPortsWithResponse ¶
func (c *ClientWithResponses) GetPorteventsPortsWithResponse(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortsResponse, error)
GetPorteventsPortsWithResponse request returning *GetPorteventsPortsResponse
func (*ClientWithResponses) GetPorteventsVesselIdLastWithResponse ¶
func (c *ClientWithResponses) GetPorteventsVesselIdLastWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdLastResponse, error)
GetPorteventsVesselIdLastWithResponse request returning *GetPorteventsVesselIdLastResponse
func (*ClientWithResponses) GetPorteventsVesselIdWithResponse ¶
func (c *ClientWithResponses) GetPorteventsVesselIdWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdResponse, error)
GetPorteventsVesselIdWithResponse request returning *GetPorteventsVesselIdResponse
func (*ClientWithResponses) GetPorteventsVesselsWithResponse ¶
func (c *ClientWithResponses) GetPorteventsVesselsWithResponse(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselsResponse, error)
GetPorteventsVesselsWithResponse request returning *GetPorteventsVesselsResponse
func (*ClientWithResponses) GetPorteventsWithResponse ¶
func (c *ClientWithResponses) GetPorteventsWithResponse(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*GetPorteventsResponse, error)
GetPorteventsWithResponse request returning *GetPorteventsResponse
func (*ClientWithResponses) GetSearchDgpsWithResponse ¶
func (c *ClientWithResponses) GetSearchDgpsWithResponse(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*GetSearchDgpsResponse, error)
GetSearchDgpsWithResponse request returning *GetSearchDgpsResponse
func (*ClientWithResponses) GetSearchLightaidsWithResponse ¶
func (c *ClientWithResponses) GetSearchLightaidsWithResponse(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*GetSearchLightaidsResponse, error)
GetSearchLightaidsWithResponse request returning *GetSearchLightaidsResponse
func (*ClientWithResponses) GetSearchModusWithResponse ¶
func (c *ClientWithResponses) GetSearchModusWithResponse(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*GetSearchModusResponse, error)
GetSearchModusWithResponse request returning *GetSearchModusResponse
func (*ClientWithResponses) GetSearchPortsWithResponse ¶
func (c *ClientWithResponses) GetSearchPortsWithResponse(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*GetSearchPortsResponse, error)
GetSearchPortsWithResponse request returning *GetSearchPortsResponse
func (*ClientWithResponses) GetSearchRadiobeaconsWithResponse ¶
func (c *ClientWithResponses) GetSearchRadiobeaconsWithResponse(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*GetSearchRadiobeaconsResponse, error)
GetSearchRadiobeaconsWithResponse request returning *GetSearchRadiobeaconsResponse
func (*ClientWithResponses) GetSearchVesselsWithResponse ¶
func (c *ClientWithResponses) GetSearchVesselsWithResponse(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*GetSearchVesselsResponse, error)
GetSearchVesselsWithResponse request returning *GetSearchVesselsResponse
func (*ClientWithResponses) GetVesselIdCasualtiesWithResponse ¶
func (c *ClientWithResponses) GetVesselIdCasualtiesWithResponse(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*GetVesselIdCasualtiesResponse, error)
GetVesselIdCasualtiesWithResponse request returning *GetVesselIdCasualtiesResponse
func (*ClientWithResponses) GetVesselIdClassificationWithResponse ¶
func (c *ClientWithResponses) GetVesselIdClassificationWithResponse(ctx context.Context, id string, params *GetVesselIdClassificationParams, reqEditors ...RequestEditorFn) (*GetVesselIdClassificationResponse, error)
GetVesselIdClassificationWithResponse request returning *GetVesselIdClassificationResponse
func (*ClientWithResponses) GetVesselIdEmissionsWithResponse ¶
func (c *ClientWithResponses) GetVesselIdEmissionsWithResponse(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*GetVesselIdEmissionsResponse, error)
GetVesselIdEmissionsWithResponse request returning *GetVesselIdEmissionsResponse
func (*ClientWithResponses) GetVesselIdEtaWithResponse ¶
func (c *ClientWithResponses) GetVesselIdEtaWithResponse(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*GetVesselIdEtaResponse, error)
GetVesselIdEtaWithResponse request returning *GetVesselIdEtaResponse
func (*ClientWithResponses) GetVesselIdInspectionsDetailIdWithResponse ¶
func (c *ClientWithResponses) GetVesselIdInspectionsDetailIdWithResponse(ctx context.Context, id string, detailId string, params *GetVesselIdInspectionsDetailIdParams, reqEditors ...RequestEditorFn) (*GetVesselIdInspectionsDetailIdResponse, error)
GetVesselIdInspectionsDetailIdWithResponse request returning *GetVesselIdInspectionsDetailIdResponse
func (*ClientWithResponses) GetVesselIdInspectionsWithResponse ¶
func (c *ClientWithResponses) GetVesselIdInspectionsWithResponse(ctx context.Context, id string, params *GetVesselIdInspectionsParams, reqEditors ...RequestEditorFn) (*GetVesselIdInspectionsResponse, error)
GetVesselIdInspectionsWithResponse request returning *GetVesselIdInspectionsResponse
func (*ClientWithResponses) GetVesselIdOwnershipWithResponse ¶
func (c *ClientWithResponses) GetVesselIdOwnershipWithResponse(ctx context.Context, id string, params *GetVesselIdOwnershipParams, reqEditors ...RequestEditorFn) (*GetVesselIdOwnershipResponse, error)
GetVesselIdOwnershipWithResponse request returning *GetVesselIdOwnershipResponse
func (*ClientWithResponses) GetVesselIdPositionWithResponse ¶
func (c *ClientWithResponses) GetVesselIdPositionWithResponse(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*GetVesselIdPositionResponse, error)
GetVesselIdPositionWithResponse request returning *GetVesselIdPositionResponse
func (*ClientWithResponses) GetVesselIdWithResponse ¶
func (c *ClientWithResponses) GetVesselIdWithResponse(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*GetVesselIdResponse, error)
GetVesselIdWithResponse request returning *GetVesselIdResponse
func (*ClientWithResponses) GetVesselsPositionsWithResponse ¶
func (c *ClientWithResponses) GetVesselsPositionsWithResponse(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*GetVesselsPositionsResponse, error)
GetVesselsPositionsWithResponse request returning *GetVesselsPositionsResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// GetEmissionsWithResponse request
GetEmissionsWithResponse(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*GetEmissionsResponse, error)
// GetLocationDgpsBoundingBoxWithResponse request
GetLocationDgpsBoundingBoxWithResponse(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsBoundingBoxResponse, error)
// GetLocationDgpsRadiusWithResponse request
GetLocationDgpsRadiusWithResponse(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsRadiusResponse, error)
// GetLocationLightaidsBoundingBoxWithResponse request
GetLocationLightaidsBoundingBoxWithResponse(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsBoundingBoxResponse, error)
// GetLocationLightaidsRadiusWithResponse request
GetLocationLightaidsRadiusWithResponse(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsRadiusResponse, error)
// GetLocationModuBoundingBoxWithResponse request
GetLocationModuBoundingBoxWithResponse(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationModuBoundingBoxResponse, error)
// GetLocationModuRadiusWithResponse request
GetLocationModuRadiusWithResponse(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationModuRadiusResponse, error)
// GetLocationPortsBoundingBoxWithResponse request
GetLocationPortsBoundingBoxWithResponse(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationPortsBoundingBoxResponse, error)
// GetLocationPortsRadiusWithResponse request
GetLocationPortsRadiusWithResponse(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationPortsRadiusResponse, error)
// GetLocationRadiobeaconsBoundingBoxWithResponse request
GetLocationRadiobeaconsBoundingBoxWithResponse(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsBoundingBoxResponse, error)
// GetLocationRadiobeaconsRadiusWithResponse request
GetLocationRadiobeaconsRadiusWithResponse(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsRadiusResponse, error)
// GetLocationVesselsBoundingBoxWithResponse request
GetLocationVesselsBoundingBoxWithResponse(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsBoundingBoxResponse, error)
// GetLocationVesselsRadiusWithResponse request
GetLocationVesselsRadiusWithResponse(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsRadiusResponse, error)
GetNavtexWithResponse(ctx context.Context, params *GetNavtexParams, reqEditors ...RequestEditorFn) (*GetNavtexResponse, error)
// GetPortUnlocodeWithResponse request
GetPortUnlocodeWithResponse(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*GetPortUnlocodeResponse, error)
// GetPorteventsWithResponse request
GetPorteventsWithResponse(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*GetPorteventsResponse, error)
// GetPorteventsPortUnlocodeWithResponse request
GetPorteventsPortUnlocodeWithResponse(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortUnlocodeResponse, error)
// GetPorteventsPortsWithResponse request
GetPorteventsPortsWithResponse(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortsResponse, error)
// GetPorteventsVesselIdWithResponse request
GetPorteventsVesselIdWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdResponse, error)
// GetPorteventsVesselIdLastWithResponse request
GetPorteventsVesselIdLastWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdLastResponse, error)
// GetPorteventsVesselsWithResponse request
GetPorteventsVesselsWithResponse(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselsResponse, error)
// GetSearchDgpsWithResponse request
GetSearchDgpsWithResponse(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*GetSearchDgpsResponse, error)
// GetSearchLightaidsWithResponse request
GetSearchLightaidsWithResponse(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*GetSearchLightaidsResponse, error)
// GetSearchModusWithResponse request
GetSearchModusWithResponse(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*GetSearchModusResponse, error)
// GetSearchPortsWithResponse request
GetSearchPortsWithResponse(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*GetSearchPortsResponse, error)
// GetSearchRadiobeaconsWithResponse request
GetSearchRadiobeaconsWithResponse(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*GetSearchRadiobeaconsResponse, error)
// GetSearchVesselsWithResponse request
GetSearchVesselsWithResponse(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*GetSearchVesselsResponse, error)
// GetVesselIdWithResponse request
GetVesselIdWithResponse(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*GetVesselIdResponse, error)
// GetVesselIdCasualtiesWithResponse request
GetVesselIdCasualtiesWithResponse(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*GetVesselIdCasualtiesResponse, error)
// GetVesselIdClassificationWithResponse request
GetVesselIdClassificationWithResponse(ctx context.Context, id string, params *GetVesselIdClassificationParams, reqEditors ...RequestEditorFn) (*GetVesselIdClassificationResponse, error)
// GetVesselIdEmissionsWithResponse request
GetVesselIdEmissionsWithResponse(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*GetVesselIdEmissionsResponse, error)
// GetVesselIdEtaWithResponse request
GetVesselIdEtaWithResponse(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*GetVesselIdEtaResponse, error)
// GetVesselIdInspectionsWithResponse request
GetVesselIdInspectionsWithResponse(ctx context.Context, id string, params *GetVesselIdInspectionsParams, reqEditors ...RequestEditorFn) (*GetVesselIdInspectionsResponse, error)
// GetVesselIdInspectionsDetailIdWithResponse request
GetVesselIdInspectionsDetailIdWithResponse(ctx context.Context, id string, detailId string, params *GetVesselIdInspectionsDetailIdParams, reqEditors ...RequestEditorFn) (*GetVesselIdInspectionsDetailIdResponse, error)
// GetVesselIdOwnershipWithResponse request
GetVesselIdOwnershipWithResponse(ctx context.Context, id string, params *GetVesselIdOwnershipParams, reqEditors ...RequestEditorFn) (*GetVesselIdOwnershipResponse, error)
// GetVesselIdPositionWithResponse request
GetVesselIdPositionWithResponse(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*GetVesselIdPositionResponse, error)
// GetVesselsPositionsWithResponse request
GetVesselsPositionsWithResponse(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*GetVesselsPositionsResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type DGPSStation ¶
type DGPSStation struct {
// AidType Type of navigational aid
AidType *string `json:"aid_type,omitempty"`
// DeleteFlag Deletion status flag
DeleteFlag *string `json:"delete_flag,omitempty"`
// FeatureNumber NGA feature number identifier
FeatureNumber *int `json:"feature_number,omitempty"`
// Frequency Broadcast frequency in kHz
Frequency *float32 `json:"frequency,omitempty"`
// GeopoliticalHeading Country or major geographic area
GeopoliticalHeading *string `json:"geopolitical_heading,omitempty"`
// Location GeoJSON point for geospatial queries
Location *GithubComVesselapiCommonVesselDataContractsTypesGeoJSON `json:"location,omitempty"`
// Name Station name
Name *string `json:"name,omitempty"`
// NoticeNumber Notice to Mariners number
NoticeNumber *int `json:"notice_number,omitempty"`
// NoticeWeek Week of the notice
NoticeWeek *string `json:"notice_week,omitempty"`
// NoticeYear Year of the notice
NoticeYear *string `json:"notice_year,omitempty"`
// Position Human-readable position description
Position *string `json:"position,omitempty"`
// PostNote Notes appearing after the main entry
PostNote *string `json:"post_note,omitempty"`
// PrecedingNote Notes appearing before the main entry
PrecedingNote *string `json:"preceding_note,omitempty"`
// Range Signal range in nautical miles
Range *int `json:"range,omitempty"`
// RegionHeading Regional geographic subdivision
RegionHeading *string `json:"region_heading,omitempty"`
// Remarks Additional remarks about the station
Remarks *string `json:"remarks,omitempty"`
// RemoveFromList Flag indicating if entry should be removed
RemoveFromList *string `json:"remove_from_list,omitempty"`
// StationId StationID Station identifier code
StationId *string `json:"station_id,omitempty"`
// TransferRate Data transfer rate in bits per second
TransferRate *int `json:"transfer_rate,omitempty"`
// VolumeNumber NGA publication volume number
VolumeNumber *string `json:"volume_number,omitempty"`
}
DGPSStation Differential GPS (DGPS) correction signal broadcast station
type DGPSStationsWithinLocationResponse ¶
type DGPSStationsWithinLocationResponse struct {
// DgpsStations List of DGPS stations within the specified area
DgpsStations *[]DGPSStation `json:"dgpsStations,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
DGPSStationsWithinLocationResponse Response containing DGPS stations within location data
type EmissionsService ¶
type EmissionsService struct {
// contains filtered or unexported fields
}
EmissionsService wraps emissions API endpoints.
func (*EmissionsService) List ¶
func (s *EmissionsService) List(ctx context.Context, params *GetEmissionsParams) (*VesselEmissionsResponse, error)
List retrieves vessel emissions data.
func (*EmissionsService) ListAll ¶
func (s *EmissionsService) ListAll(ctx context.Context, params *GetEmissionsParams) *Iterator[VesselEmission]
ListAll returns an iterator over all emissions across all pages.
type ErrorCode ¶
type ErrorCode string
ErrorCode Machine-readable error code for programmatic handling
const ( ErrorCodeDatabaseError ErrorCode = "database_error" ErrorCodeInternalError ErrorCode = "internal_error" ErrorCodeInvalidAPIKey ErrorCode = "invalid_api_key" ErrorCodeInvalidCoordinates ErrorCode = "invalid_coordinates" ErrorCodeInvalidIMO ErrorCode = "invalid_imo" ErrorCodeInvalidMMSI ErrorCode = "invalid_mmsi" ErrorCodeInvalidParameter ErrorCode = "invalid_parameter" ErrorCodeInvalidTimeRange ErrorCode = "invalid_time_range" ErrorCodeMissingParameter ErrorCode = "missing_parameter" ErrorCodeRateLimitExceeded ErrorCode = "rate_limit_exceeded" ErrorCodeResourceMissing ErrorCode = "resource_missing" )
Defines values for ErrorCode.
type ErrorType ¶
type ErrorType string
ErrorType High-level error category classification
const ( ErrorTypeAPIError ErrorType = "api_error" ErrorTypeAuthenticationError ErrorType = "authentication_error" ErrorTypeInvalidRequest ErrorType = "invalid_request_error" ErrorTypeNotFoundError ErrorType = "not_found_error" ErrorTypeRateLimitError ErrorType = "rate_limit_error" )
Defines values for ErrorType.
type FindDGPSStationsResponse ¶
type FindDGPSStationsResponse struct {
// DgpsStations List of matching DGPS stations
DgpsStations *[]DGPSStation `json:"dgpsStations,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
FindDGPSStationsResponse Response containing dgps station data
type FindLightAidsResponse ¶
type FindLightAidsResponse struct {
// LightAids List of matching light aids
LightAids *[]LightAid `json:"lightAids,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
FindLightAidsResponse Response containing light aid data
type FindMODUsResponse ¶
type FindMODUsResponse struct {
// Modus List of matching MODUs
Modus *[]MODU `json:"modus,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
FindMODUsResponse Response containing MODU search results
type FindPortsResponse ¶
type FindPortsResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// Ports List of matching ports
Ports *[]Port `json:"ports,omitempty"`
}
FindPortsResponse Response containing port data
type FindRadioBeaconsResponse ¶
type FindRadioBeaconsResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// RadioBeacons List of matching radio beacons
RadioBeacons *[]RadioBeacon `json:"radioBeacons,omitempty"`
}
FindRadioBeaconsResponse Response containing radio beacon data
type FindVesselsResponse ¶
type FindVesselsResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// Vessels List of matching vessels
Vessels *[]Vessel `json:"vessels,omitempty"`
}
FindVesselsResponse Response containing vessel search results
type GetEmissionsParams ¶
type GetEmissionsParams struct {
// FilterPeriod Reporting year filter (e.g. 2024)
FilterPeriod *int `form:"filter.period,omitempty" json:"filter.period,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetEmissionsParams defines parameters for GetEmissions.
type GetEmissionsResponse ¶
type GetEmissionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselEmissionsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetEmissionsResponse ¶
func ParseGetEmissionsResponse(rsp *http.Response) (*GetEmissionsResponse, error)
ParseGetEmissionsResponse parses an HTTP response from a GetEmissionsWithResponse call
func (GetEmissionsResponse) Status ¶
func (r GetEmissionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetEmissionsResponse) StatusCode ¶
func (r GetEmissionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationDgpsBoundingBoxParams ¶
type GetLocationDgpsBoundingBoxParams struct {
// FilterLonLeft Longitude of the left (western) edge of the bounding box
FilterLonLeft *float64 `form:"filter.lonLeft,omitempty" json:"filter.lonLeft,omitempty"`
// FilterLonRight Longitude of the right (eastern) edge of the bounding box
FilterLonRight *float64 `form:"filter.lonRight,omitempty" json:"filter.lonRight,omitempty"`
// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
FilterLatBottom *float64 `form:"filter.latBottom,omitempty" json:"filter.latBottom,omitempty"`
// FilterLatTop Latitude of the top (northern) edge of the bounding box
FilterLatTop *float64 `form:"filter.latTop,omitempty" json:"filter.latTop,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationDgpsBoundingBoxParams defines parameters for GetLocationDgpsBoundingBox.
type GetLocationDgpsBoundingBoxResponse ¶
type GetLocationDgpsBoundingBoxResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *DGPSStationsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationDgpsBoundingBoxResponse ¶
func ParseGetLocationDgpsBoundingBoxResponse(rsp *http.Response) (*GetLocationDgpsBoundingBoxResponse, error)
ParseGetLocationDgpsBoundingBoxResponse parses an HTTP response from a GetLocationDgpsBoundingBoxWithResponse call
func (GetLocationDgpsBoundingBoxResponse) Status ¶
func (r GetLocationDgpsBoundingBoxResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationDgpsBoundingBoxResponse) StatusCode ¶
func (r GetLocationDgpsBoundingBoxResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationDgpsRadiusParams ¶
type GetLocationDgpsRadiusParams struct {
// FilterLongitude Longitude of the center point
FilterLongitude *float64 `form:"filter.longitude,omitempty" json:"filter.longitude,omitempty"`
// FilterLatitude Latitude of the center point
FilterLatitude *float64 `form:"filter.latitude,omitempty" json:"filter.latitude,omitempty"`
// FilterRadius Search radius in meters (max 100,000 = 100 km)
FilterRadius float64 `form:"filter.radius" json:"filter.radius"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationDgpsRadiusParams defines parameters for GetLocationDgpsRadius.
type GetLocationDgpsRadiusResponse ¶
type GetLocationDgpsRadiusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *DGPSStationsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationDgpsRadiusResponse ¶
func ParseGetLocationDgpsRadiusResponse(rsp *http.Response) (*GetLocationDgpsRadiusResponse, error)
ParseGetLocationDgpsRadiusResponse parses an HTTP response from a GetLocationDgpsRadiusWithResponse call
func (GetLocationDgpsRadiusResponse) Status ¶
func (r GetLocationDgpsRadiusResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationDgpsRadiusResponse) StatusCode ¶
func (r GetLocationDgpsRadiusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationLightaidsBoundingBoxParams ¶
type GetLocationLightaidsBoundingBoxParams struct {
// FilterLonLeft Longitude of the left (western) edge of the bounding box
FilterLonLeft *float64 `form:"filter.lonLeft,omitempty" json:"filter.lonLeft,omitempty"`
// FilterLonRight Longitude of the right (eastern) edge of the bounding box
FilterLonRight *float64 `form:"filter.lonRight,omitempty" json:"filter.lonRight,omitempty"`
// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
FilterLatBottom *float64 `form:"filter.latBottom,omitempty" json:"filter.latBottom,omitempty"`
// FilterLatTop Latitude of the top (northern) edge of the bounding box
FilterLatTop *float64 `form:"filter.latTop,omitempty" json:"filter.latTop,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationLightaidsBoundingBoxParams defines parameters for GetLocationLightaidsBoundingBox.
type GetLocationLightaidsBoundingBoxResponse ¶
type GetLocationLightaidsBoundingBoxResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *LightAidsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationLightaidsBoundingBoxResponse ¶
func ParseGetLocationLightaidsBoundingBoxResponse(rsp *http.Response) (*GetLocationLightaidsBoundingBoxResponse, error)
ParseGetLocationLightaidsBoundingBoxResponse parses an HTTP response from a GetLocationLightaidsBoundingBoxWithResponse call
func (GetLocationLightaidsBoundingBoxResponse) Status ¶
func (r GetLocationLightaidsBoundingBoxResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationLightaidsBoundingBoxResponse) StatusCode ¶
func (r GetLocationLightaidsBoundingBoxResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationLightaidsRadiusParams ¶
type GetLocationLightaidsRadiusParams struct {
// FilterLongitude Longitude of the center point
FilterLongitude *float64 `form:"filter.longitude,omitempty" json:"filter.longitude,omitempty"`
// FilterLatitude Latitude of the center point
FilterLatitude *float64 `form:"filter.latitude,omitempty" json:"filter.latitude,omitempty"`
// FilterRadius Search radius in meters (max 100,000 = 100 km)
FilterRadius float64 `form:"filter.radius" json:"filter.radius"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationLightaidsRadiusParams defines parameters for GetLocationLightaidsRadius.
type GetLocationLightaidsRadiusResponse ¶
type GetLocationLightaidsRadiusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *LightAidsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationLightaidsRadiusResponse ¶
func ParseGetLocationLightaidsRadiusResponse(rsp *http.Response) (*GetLocationLightaidsRadiusResponse, error)
ParseGetLocationLightaidsRadiusResponse parses an HTTP response from a GetLocationLightaidsRadiusWithResponse call
func (GetLocationLightaidsRadiusResponse) Status ¶
func (r GetLocationLightaidsRadiusResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationLightaidsRadiusResponse) StatusCode ¶
func (r GetLocationLightaidsRadiusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationModuBoundingBoxParams ¶
type GetLocationModuBoundingBoxParams struct {
// FilterLonLeft Longitude of the left (western) edge of the bounding box
FilterLonLeft *float64 `form:"filter.lonLeft,omitempty" json:"filter.lonLeft,omitempty"`
// FilterLonRight Longitude of the right (eastern) edge of the bounding box
FilterLonRight *float64 `form:"filter.lonRight,omitempty" json:"filter.lonRight,omitempty"`
// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
FilterLatBottom *float64 `form:"filter.latBottom,omitempty" json:"filter.latBottom,omitempty"`
// FilterLatTop Latitude of the top (northern) edge of the bounding box
FilterLatTop *float64 `form:"filter.latTop,omitempty" json:"filter.latTop,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationModuBoundingBoxParams defines parameters for GetLocationModuBoundingBox.
type GetLocationModuBoundingBoxResponse ¶
type GetLocationModuBoundingBoxResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MODUsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationModuBoundingBoxResponse ¶
func ParseGetLocationModuBoundingBoxResponse(rsp *http.Response) (*GetLocationModuBoundingBoxResponse, error)
ParseGetLocationModuBoundingBoxResponse parses an HTTP response from a GetLocationModuBoundingBoxWithResponse call
func (GetLocationModuBoundingBoxResponse) Status ¶
func (r GetLocationModuBoundingBoxResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationModuBoundingBoxResponse) StatusCode ¶
func (r GetLocationModuBoundingBoxResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationModuRadiusParams ¶
type GetLocationModuRadiusParams struct {
// FilterLongitude Longitude of the center point
FilterLongitude *float64 `form:"filter.longitude,omitempty" json:"filter.longitude,omitempty"`
// FilterLatitude Latitude of the center point
FilterLatitude *float64 `form:"filter.latitude,omitempty" json:"filter.latitude,omitempty"`
// FilterRadius Search radius in meters (max 100,000 = 100 km)
FilterRadius float64 `form:"filter.radius" json:"filter.radius"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationModuRadiusParams defines parameters for GetLocationModuRadius.
type GetLocationModuRadiusResponse ¶
type GetLocationModuRadiusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MODUsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationModuRadiusResponse ¶
func ParseGetLocationModuRadiusResponse(rsp *http.Response) (*GetLocationModuRadiusResponse, error)
ParseGetLocationModuRadiusResponse parses an HTTP response from a GetLocationModuRadiusWithResponse call
func (GetLocationModuRadiusResponse) Status ¶
func (r GetLocationModuRadiusResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationModuRadiusResponse) StatusCode ¶
func (r GetLocationModuRadiusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationPortsBoundingBoxParams ¶
type GetLocationPortsBoundingBoxParams struct {
// FilterLonLeft Longitude of the left (western) edge of the bounding box
FilterLonLeft *float64 `form:"filter.lonLeft,omitempty" json:"filter.lonLeft,omitempty"`
// FilterLonRight Longitude of the right (eastern) edge of the bounding box
FilterLonRight *float64 `form:"filter.lonRight,omitempty" json:"filter.lonRight,omitempty"`
// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
FilterLatBottom *float64 `form:"filter.latBottom,omitempty" json:"filter.latBottom,omitempty"`
// FilterLatTop Latitude of the top (northern) edge of the bounding box
FilterLatTop *float64 `form:"filter.latTop,omitempty" json:"filter.latTop,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationPortsBoundingBoxParams defines parameters for GetLocationPortsBoundingBox.
type GetLocationPortsBoundingBoxResponse ¶
type GetLocationPortsBoundingBoxResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationPortsBoundingBoxResponse ¶
func ParseGetLocationPortsBoundingBoxResponse(rsp *http.Response) (*GetLocationPortsBoundingBoxResponse, error)
ParseGetLocationPortsBoundingBoxResponse parses an HTTP response from a GetLocationPortsBoundingBoxWithResponse call
func (GetLocationPortsBoundingBoxResponse) Status ¶
func (r GetLocationPortsBoundingBoxResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationPortsBoundingBoxResponse) StatusCode ¶
func (r GetLocationPortsBoundingBoxResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationPortsRadiusParams ¶
type GetLocationPortsRadiusParams struct {
// FilterLongitude Longitude of the center point
FilterLongitude *float64 `form:"filter.longitude,omitempty" json:"filter.longitude,omitempty"`
// FilterLatitude Latitude of the center point
FilterLatitude *float64 `form:"filter.latitude,omitempty" json:"filter.latitude,omitempty"`
// FilterRadius Search radius in meters (max 100,000 = 100 km)
FilterRadius float64 `form:"filter.radius" json:"filter.radius"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationPortsRadiusParams defines parameters for GetLocationPortsRadius.
type GetLocationPortsRadiusResponse ¶
type GetLocationPortsRadiusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationPortsRadiusResponse ¶
func ParseGetLocationPortsRadiusResponse(rsp *http.Response) (*GetLocationPortsRadiusResponse, error)
ParseGetLocationPortsRadiusResponse parses an HTTP response from a GetLocationPortsRadiusWithResponse call
func (GetLocationPortsRadiusResponse) Status ¶
func (r GetLocationPortsRadiusResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationPortsRadiusResponse) StatusCode ¶
func (r GetLocationPortsRadiusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationRadiobeaconsBoundingBoxParams ¶
type GetLocationRadiobeaconsBoundingBoxParams struct {
// FilterLonLeft Longitude of the left (western) edge of the bounding box
FilterLonLeft *float64 `form:"filter.lonLeft,omitempty" json:"filter.lonLeft,omitempty"`
// FilterLonRight Longitude of the right (eastern) edge of the bounding box
FilterLonRight *float64 `form:"filter.lonRight,omitempty" json:"filter.lonRight,omitempty"`
// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
FilterLatBottom *float64 `form:"filter.latBottom,omitempty" json:"filter.latBottom,omitempty"`
// FilterLatTop Latitude of the top (northern) edge of the bounding box
FilterLatTop *float64 `form:"filter.latTop,omitempty" json:"filter.latTop,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationRadiobeaconsBoundingBoxParams defines parameters for GetLocationRadiobeaconsBoundingBox.
type GetLocationRadiobeaconsBoundingBoxResponse ¶
type GetLocationRadiobeaconsBoundingBoxResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RadioBeaconsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationRadiobeaconsBoundingBoxResponse ¶
func ParseGetLocationRadiobeaconsBoundingBoxResponse(rsp *http.Response) (*GetLocationRadiobeaconsBoundingBoxResponse, error)
ParseGetLocationRadiobeaconsBoundingBoxResponse parses an HTTP response from a GetLocationRadiobeaconsBoundingBoxWithResponse call
func (GetLocationRadiobeaconsBoundingBoxResponse) Status ¶
func (r GetLocationRadiobeaconsBoundingBoxResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationRadiobeaconsBoundingBoxResponse) StatusCode ¶
func (r GetLocationRadiobeaconsBoundingBoxResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationRadiobeaconsRadiusParams ¶
type GetLocationRadiobeaconsRadiusParams struct {
// FilterLongitude Longitude of the center point
FilterLongitude *float64 `form:"filter.longitude,omitempty" json:"filter.longitude,omitempty"`
// FilterLatitude Latitude of the center point
FilterLatitude *float64 `form:"filter.latitude,omitempty" json:"filter.latitude,omitempty"`
// FilterRadius Search radius in meters (max 100,000 = 100 km)
FilterRadius float64 `form:"filter.radius" json:"filter.radius"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationRadiobeaconsRadiusParams defines parameters for GetLocationRadiobeaconsRadius.
type GetLocationRadiobeaconsRadiusResponse ¶
type GetLocationRadiobeaconsRadiusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RadioBeaconsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationRadiobeaconsRadiusResponse ¶
func ParseGetLocationRadiobeaconsRadiusResponse(rsp *http.Response) (*GetLocationRadiobeaconsRadiusResponse, error)
ParseGetLocationRadiobeaconsRadiusResponse parses an HTTP response from a GetLocationRadiobeaconsRadiusWithResponse call
func (GetLocationRadiobeaconsRadiusResponse) Status ¶
func (r GetLocationRadiobeaconsRadiusResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationRadiobeaconsRadiusResponse) StatusCode ¶
func (r GetLocationRadiobeaconsRadiusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationVesselsBoundingBoxParams ¶
type GetLocationVesselsBoundingBoxParams struct {
// FilterLonLeft Longitude of the left (western) edge of the bounding box
FilterLonLeft *float64 `form:"filter.lonLeft,omitempty" json:"filter.lonLeft,omitempty"`
// FilterLonRight Longitude of the right (eastern) edge of the bounding box
FilterLonRight *float64 `form:"filter.lonRight,omitempty" json:"filter.lonRight,omitempty"`
// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
FilterLatBottom *float64 `form:"filter.latBottom,omitempty" json:"filter.latBottom,omitempty"`
// FilterLatTop Latitude of the top (northern) edge of the bounding box
FilterLatTop *float64 `form:"filter.latTop,omitempty" json:"filter.latTop,omitempty"`
// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`
// TimeTo End timestamp in RFC3339 format (defaults to current time)
TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationVesselsBoundingBoxParams defines parameters for GetLocationVesselsBoundingBox.
type GetLocationVesselsBoundingBoxResponse ¶
type GetLocationVesselsBoundingBoxResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationVesselsBoundingBoxResponse ¶
func ParseGetLocationVesselsBoundingBoxResponse(rsp *http.Response) (*GetLocationVesselsBoundingBoxResponse, error)
ParseGetLocationVesselsBoundingBoxResponse parses an HTTP response from a GetLocationVesselsBoundingBoxWithResponse call
func (GetLocationVesselsBoundingBoxResponse) Status ¶
func (r GetLocationVesselsBoundingBoxResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationVesselsBoundingBoxResponse) StatusCode ¶
func (r GetLocationVesselsBoundingBoxResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetLocationVesselsRadiusParams ¶
type GetLocationVesselsRadiusParams struct {
// FilterLongitude Longitude of the center point
FilterLongitude *float64 `form:"filter.longitude,omitempty" json:"filter.longitude,omitempty"`
// FilterLatitude Latitude of the center point
FilterLatitude *float64 `form:"filter.latitude,omitempty" json:"filter.latitude,omitempty"`
// FilterRadius Search radius in meters (max 100,000 = 100 km)
FilterRadius float64 `form:"filter.radius" json:"filter.radius"`
// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`
// TimeTo End timestamp in RFC3339 format (defaults to current time)
TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetLocationVesselsRadiusParams defines parameters for GetLocationVesselsRadius.
type GetLocationVesselsRadiusResponse ¶
type GetLocationVesselsRadiusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselsWithinLocationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetLocationVesselsRadiusResponse ¶
func ParseGetLocationVesselsRadiusResponse(rsp *http.Response) (*GetLocationVesselsRadiusResponse, error)
ParseGetLocationVesselsRadiusResponse parses an HTTP response from a GetLocationVesselsRadiusWithResponse call
func (GetLocationVesselsRadiusResponse) Status ¶
func (r GetLocationVesselsRadiusResponse) Status() string
Status returns HTTPResponse.Status
func (GetLocationVesselsRadiusResponse) StatusCode ¶
func (r GetLocationVesselsRadiusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetNavtexParams ¶
type GetNavtexParams struct {
TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`
TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetNavtexParams defines parameters for GetNavtex.
type GetNavtexResponse ¶
type GetNavtexResponse struct {
}
func ParseGetNavtexResponse ¶
func ParseGetNavtexResponse(rsp *http.Response) (*GetNavtexResponse, error)
ParseGetNavtexResponse parses an HTTP response from a GetNavtexWithResponse call
func (GetNavtexResponse) Status ¶
func (r GetNavtexResponse) Status() string
Status returns HTTPResponse.Status
func (GetNavtexResponse) StatusCode ¶
func (r GetNavtexResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPortUnlocodeResponse ¶
type GetPortUnlocodeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPortUnlocodeResponse ¶
func ParseGetPortUnlocodeResponse(rsp *http.Response) (*GetPortUnlocodeResponse, error)
ParseGetPortUnlocodeResponse parses an HTTP response from a GetPortUnlocodeWithResponse call
func (GetPortUnlocodeResponse) Status ¶
func (r GetPortUnlocodeResponse) Status() string
Status returns HTTPResponse.Status
func (GetPortUnlocodeResponse) StatusCode ¶
func (r GetPortUnlocodeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPorteventsParams ¶
type GetPorteventsParams struct {
// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`
// TimeTo End timestamp in RFC3339 format (defaults to current time)
TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetPorteventsParams defines parameters for GetPortevents.
type GetPorteventsPortUnlocodeParams ¶
type GetPorteventsPortUnlocodeParams struct {
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetPorteventsPortUnlocodeParams defines parameters for GetPorteventsPortUnlocode.
type GetPorteventsPortUnlocodeResponse ¶
type GetPorteventsPortUnlocodeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortEventsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPorteventsPortUnlocodeResponse ¶
func ParseGetPorteventsPortUnlocodeResponse(rsp *http.Response) (*GetPorteventsPortUnlocodeResponse, error)
ParseGetPorteventsPortUnlocodeResponse parses an HTTP response from a GetPorteventsPortUnlocodeWithResponse call
func (GetPorteventsPortUnlocodeResponse) Status ¶
func (r GetPorteventsPortUnlocodeResponse) Status() string
Status returns HTTPResponse.Status
func (GetPorteventsPortUnlocodeResponse) StatusCode ¶
func (r GetPorteventsPortUnlocodeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPorteventsPortsParams ¶
type GetPorteventsPortsParams struct {
// FilterPortName Port name
FilterPortName string `form:"filter.portName" json:"filter.portName"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetPorteventsPortsParams defines parameters for GetPorteventsPorts.
type GetPorteventsPortsResponse ¶
type GetPorteventsPortsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortEventsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPorteventsPortsResponse ¶
func ParseGetPorteventsPortsResponse(rsp *http.Response) (*GetPorteventsPortsResponse, error)
ParseGetPorteventsPortsResponse parses an HTTP response from a GetPorteventsPortsWithResponse call
func (GetPorteventsPortsResponse) Status ¶
func (r GetPorteventsPortsResponse) Status() string
Status returns HTTPResponse.Status
func (GetPorteventsPortsResponse) StatusCode ¶
func (r GetPorteventsPortsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPorteventsResponse ¶
type GetPorteventsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortEventsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPorteventsResponse ¶
func ParseGetPorteventsResponse(rsp *http.Response) (*GetPorteventsResponse, error)
ParseGetPorteventsResponse parses an HTTP response from a GetPorteventsWithResponse call
func (GetPorteventsResponse) Status ¶
func (r GetPorteventsResponse) Status() string
Status returns HTTPResponse.Status
func (GetPorteventsResponse) StatusCode ¶
func (r GetPorteventsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPorteventsVesselIdLastParams ¶
type GetPorteventsVesselIdLastParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetPorteventsVesselIdLastParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetPorteventsVesselIdLastParams defines parameters for GetPorteventsVesselIdLast.
type GetPorteventsVesselIdLastParamsFilterIdType ¶
type GetPorteventsVesselIdLastParamsFilterIdType string
GetPorteventsVesselIdLastParamsFilterIdType defines parameters for GetPorteventsVesselIdLast.
const ( GetPorteventsVesselIdLastParamsFilterIdTypeImo GetPorteventsVesselIdLastParamsFilterIdType = "imo" GetPorteventsVesselIdLastParamsFilterIdTypeMmsi GetPorteventsVesselIdLastParamsFilterIdType = "mmsi" )
Defines values for GetPorteventsVesselIdLastParamsFilterIdType.
type GetPorteventsVesselIdLastResponse ¶
type GetPorteventsVesselIdLastResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortEventResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPorteventsVesselIdLastResponse ¶
func ParseGetPorteventsVesselIdLastResponse(rsp *http.Response) (*GetPorteventsVesselIdLastResponse, error)
ParseGetPorteventsVesselIdLastResponse parses an HTTP response from a GetPorteventsVesselIdLastWithResponse call
func (GetPorteventsVesselIdLastResponse) Status ¶
func (r GetPorteventsVesselIdLastResponse) Status() string
Status returns HTTPResponse.Status
func (GetPorteventsVesselIdLastResponse) StatusCode ¶
func (r GetPorteventsVesselIdLastResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPorteventsVesselIdParams ¶
type GetPorteventsVesselIdParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetPorteventsVesselIdParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
// FilterEventType Filter by event type
FilterEventType *GetPorteventsVesselIdParamsFilterEventType `form:"filter.eventType,omitempty" json:"filter.eventType,omitempty"`
// FilterSortOrder Sort order by timestamp
FilterSortOrder *GetPorteventsVesselIdParamsFilterSortOrder `form:"filter.sortOrder,omitempty" json:"filter.sortOrder,omitempty"`
// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`
// TimeTo End timestamp in RFC3339 format (defaults to current time)
TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetPorteventsVesselIdParams defines parameters for GetPorteventsVesselId.
type GetPorteventsVesselIdParamsFilterEventType ¶
type GetPorteventsVesselIdParamsFilterEventType string
GetPorteventsVesselIdParamsFilterEventType defines parameters for GetPorteventsVesselId.
const ( All GetPorteventsVesselIdParamsFilterEventType = "all" Arrival GetPorteventsVesselIdParamsFilterEventType = "arrival" Departure GetPorteventsVesselIdParamsFilterEventType = "departure" )
Defines values for GetPorteventsVesselIdParamsFilterEventType.
type GetPorteventsVesselIdParamsFilterIdType ¶
type GetPorteventsVesselIdParamsFilterIdType string
GetPorteventsVesselIdParamsFilterIdType defines parameters for GetPorteventsVesselId.
const ( GetPorteventsVesselIdParamsFilterIdTypeImo GetPorteventsVesselIdParamsFilterIdType = "imo" GetPorteventsVesselIdParamsFilterIdTypeMmsi GetPorteventsVesselIdParamsFilterIdType = "mmsi" )
Defines values for GetPorteventsVesselIdParamsFilterIdType.
type GetPorteventsVesselIdParamsFilterSortOrder ¶
type GetPorteventsVesselIdParamsFilterSortOrder string
GetPorteventsVesselIdParamsFilterSortOrder defines parameters for GetPorteventsVesselId.
const ( Asc GetPorteventsVesselIdParamsFilterSortOrder = "asc" Desc GetPorteventsVesselIdParamsFilterSortOrder = "desc" )
Defines values for GetPorteventsVesselIdParamsFilterSortOrder.
type GetPorteventsVesselIdResponse ¶
type GetPorteventsVesselIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortEventsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPorteventsVesselIdResponse ¶
func ParseGetPorteventsVesselIdResponse(rsp *http.Response) (*GetPorteventsVesselIdResponse, error)
ParseGetPorteventsVesselIdResponse parses an HTTP response from a GetPorteventsVesselIdWithResponse call
func (GetPorteventsVesselIdResponse) Status ¶
func (r GetPorteventsVesselIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetPorteventsVesselIdResponse) StatusCode ¶
func (r GetPorteventsVesselIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPorteventsVesselsParams ¶
type GetPorteventsVesselsParams struct {
// FilterVesselName Vessel name
FilterVesselName string `form:"filter.vesselName" json:"filter.vesselName"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetPorteventsVesselsParams defines parameters for GetPorteventsVessels.
type GetPorteventsVesselsResponse ¶
type GetPorteventsVesselsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PortEventsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetPorteventsVesselsResponse ¶
func ParseGetPorteventsVesselsResponse(rsp *http.Response) (*GetPorteventsVesselsResponse, error)
ParseGetPorteventsVesselsResponse parses an HTTP response from a GetPorteventsVesselsWithResponse call
func (GetPorteventsVesselsResponse) Status ¶
func (r GetPorteventsVesselsResponse) Status() string
Status returns HTTPResponse.Status
func (GetPorteventsVesselsResponse) StatusCode ¶
func (r GetPorteventsVesselsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchDgpsParams ¶
type GetSearchDgpsParams struct {
// FilterName Name of the DGPS station
FilterName string `form:"filter.name" json:"filter.name"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetSearchDgpsParams defines parameters for GetSearchDgps.
type GetSearchDgpsResponse ¶
type GetSearchDgpsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FindDGPSStationsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetSearchDgpsResponse ¶
func ParseGetSearchDgpsResponse(rsp *http.Response) (*GetSearchDgpsResponse, error)
ParseGetSearchDgpsResponse parses an HTTP response from a GetSearchDgpsWithResponse call
func (GetSearchDgpsResponse) Status ¶
func (r GetSearchDgpsResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchDgpsResponse) StatusCode ¶
func (r GetSearchDgpsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchLightaidsParams ¶
type GetSearchLightaidsParams struct {
// FilterName Name of the Light Aid
FilterName string `form:"filter.name" json:"filter.name"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetSearchLightaidsParams defines parameters for GetSearchLightaids.
type GetSearchLightaidsResponse ¶
type GetSearchLightaidsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FindLightAidsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetSearchLightaidsResponse ¶
func ParseGetSearchLightaidsResponse(rsp *http.Response) (*GetSearchLightaidsResponse, error)
ParseGetSearchLightaidsResponse parses an HTTP response from a GetSearchLightaidsWithResponse call
func (GetSearchLightaidsResponse) Status ¶
func (r GetSearchLightaidsResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchLightaidsResponse) StatusCode ¶
func (r GetSearchLightaidsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchModusParams ¶
type GetSearchModusParams struct {
// FilterName Name of the MODU
FilterName string `form:"filter.name" json:"filter.name"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetSearchModusParams defines parameters for GetSearchModus.
type GetSearchModusResponse ¶
type GetSearchModusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FindMODUsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetSearchModusResponse ¶
func ParseGetSearchModusResponse(rsp *http.Response) (*GetSearchModusResponse, error)
ParseGetSearchModusResponse parses an HTTP response from a GetSearchModusWithResponse call
func (GetSearchModusResponse) Status ¶
func (r GetSearchModusResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchModusResponse) StatusCode ¶
func (r GetSearchModusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchPortsParams ¶
type GetSearchPortsParams struct {
// FilterName Name of the port
FilterName string `form:"filter.name" json:"filter.name"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetSearchPortsParams defines parameters for GetSearchPorts.
type GetSearchPortsResponse ¶
type GetSearchPortsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FindPortsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetSearchPortsResponse ¶
func ParseGetSearchPortsResponse(rsp *http.Response) (*GetSearchPortsResponse, error)
ParseGetSearchPortsResponse parses an HTTP response from a GetSearchPortsWithResponse call
func (GetSearchPortsResponse) Status ¶
func (r GetSearchPortsResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchPortsResponse) StatusCode ¶
func (r GetSearchPortsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchRadiobeaconsParams ¶
type GetSearchRadiobeaconsParams struct {
// FilterName Name of the Radio Beacon
FilterName string `form:"filter.name" json:"filter.name"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetSearchRadiobeaconsParams defines parameters for GetSearchRadiobeacons.
type GetSearchRadiobeaconsResponse ¶
type GetSearchRadiobeaconsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FindRadioBeaconsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetSearchRadiobeaconsResponse ¶
func ParseGetSearchRadiobeaconsResponse(rsp *http.Response) (*GetSearchRadiobeaconsResponse, error)
ParseGetSearchRadiobeaconsResponse parses an HTTP response from a GetSearchRadiobeaconsWithResponse call
func (GetSearchRadiobeaconsResponse) Status ¶
func (r GetSearchRadiobeaconsResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchRadiobeaconsResponse) StatusCode ¶
func (r GetSearchRadiobeaconsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSearchVesselsParams ¶
type GetSearchVesselsParams struct {
// FilterName Name of the vessel
FilterName *string `form:"filter.name,omitempty" json:"filter.name,omitempty"`
// FilterCallsign Radio callsign of the vessel
FilterCallsign *string `form:"filter.callsign,omitempty" json:"filter.callsign,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetSearchVesselsParams defines parameters for GetSearchVessels.
type GetSearchVesselsResponse ¶
type GetSearchVesselsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FindVesselsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetSearchVesselsResponse ¶
func ParseGetSearchVesselsResponse(rsp *http.Response) (*GetSearchVesselsResponse, error)
ParseGetSearchVesselsResponse parses an HTTP response from a GetSearchVesselsWithResponse call
func (GetSearchVesselsResponse) Status ¶
func (r GetSearchVesselsResponse) Status() string
Status returns HTTPResponse.Status
func (GetSearchVesselsResponse) StatusCode ¶
func (r GetSearchVesselsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdCasualtiesParams ¶
type GetVesselIdCasualtiesParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdCasualtiesParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetVesselIdCasualtiesParams defines parameters for GetVesselIdCasualties.
type GetVesselIdCasualtiesParamsFilterIdType ¶
type GetVesselIdCasualtiesParamsFilterIdType string
GetVesselIdCasualtiesParamsFilterIdType defines parameters for GetVesselIdCasualties.
const ( GetVesselIdCasualtiesParamsFilterIdTypeImo GetVesselIdCasualtiesParamsFilterIdType = "imo" GetVesselIdCasualtiesParamsFilterIdTypeMmsi GetVesselIdCasualtiesParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdCasualtiesParamsFilterIdType.
type GetVesselIdCasualtiesResponse ¶
type GetVesselIdCasualtiesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MarineCasualtiesResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdCasualtiesResponse ¶
func ParseGetVesselIdCasualtiesResponse(rsp *http.Response) (*GetVesselIdCasualtiesResponse, error)
ParseGetVesselIdCasualtiesResponse parses an HTTP response from a GetVesselIdCasualtiesWithResponse call
func (GetVesselIdCasualtiesResponse) Status ¶
func (r GetVesselIdCasualtiesResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdCasualtiesResponse) StatusCode ¶
func (r GetVesselIdCasualtiesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdClassificationParams ¶
type GetVesselIdClassificationParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdClassificationParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdClassificationParams defines parameters for GetVesselIdClassification.
type GetVesselIdClassificationParamsFilterIdType ¶
type GetVesselIdClassificationParamsFilterIdType string
GetVesselIdClassificationParamsFilterIdType defines parameters for GetVesselIdClassification.
const ( GetVesselIdClassificationParamsFilterIdTypeImo GetVesselIdClassificationParamsFilterIdType = "imo" GetVesselIdClassificationParamsFilterIdTypeMmsi GetVesselIdClassificationParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdClassificationParamsFilterIdType.
type GetVesselIdClassificationResponse ¶
type GetVesselIdClassificationResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ClassificationResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdClassificationResponse ¶
func ParseGetVesselIdClassificationResponse(rsp *http.Response) (*GetVesselIdClassificationResponse, error)
ParseGetVesselIdClassificationResponse parses an HTTP response from a GetVesselIdClassificationWithResponse call
func (GetVesselIdClassificationResponse) Status ¶
func (r GetVesselIdClassificationResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdClassificationResponse) StatusCode ¶
func (r GetVesselIdClassificationResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdEmissionsParams ¶
type GetVesselIdEmissionsParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdEmissionsParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetVesselIdEmissionsParams defines parameters for GetVesselIdEmissions.
type GetVesselIdEmissionsParamsFilterIdType ¶
type GetVesselIdEmissionsParamsFilterIdType string
GetVesselIdEmissionsParamsFilterIdType defines parameters for GetVesselIdEmissions.
const ( GetVesselIdEmissionsParamsFilterIdTypeImo GetVesselIdEmissionsParamsFilterIdType = "imo" GetVesselIdEmissionsParamsFilterIdTypeMmsi GetVesselIdEmissionsParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdEmissionsParamsFilterIdType.
type GetVesselIdEmissionsResponse ¶
type GetVesselIdEmissionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselEmissionsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdEmissionsResponse ¶
func ParseGetVesselIdEmissionsResponse(rsp *http.Response) (*GetVesselIdEmissionsResponse, error)
ParseGetVesselIdEmissionsResponse parses an HTTP response from a GetVesselIdEmissionsWithResponse call
func (GetVesselIdEmissionsResponse) Status ¶
func (r GetVesselIdEmissionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdEmissionsResponse) StatusCode ¶
func (r GetVesselIdEmissionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdEtaParams ¶
type GetVesselIdEtaParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdEtaParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdEtaParams defines parameters for GetVesselIdEta.
type GetVesselIdEtaParamsFilterIdType ¶
type GetVesselIdEtaParamsFilterIdType string
GetVesselIdEtaParamsFilterIdType defines parameters for GetVesselIdEta.
const ( GetVesselIdEtaParamsFilterIdTypeImo GetVesselIdEtaParamsFilterIdType = "imo" GetVesselIdEtaParamsFilterIdTypeMmsi GetVesselIdEtaParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdEtaParamsFilterIdType.
type GetVesselIdEtaResponse ¶
type GetVesselIdEtaResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselETAResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdEtaResponse ¶
func ParseGetVesselIdEtaResponse(rsp *http.Response) (*GetVesselIdEtaResponse, error)
ParseGetVesselIdEtaResponse parses an HTTP response from a GetVesselIdEtaWithResponse call
func (GetVesselIdEtaResponse) Status ¶
func (r GetVesselIdEtaResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdEtaResponse) StatusCode ¶
func (r GetVesselIdEtaResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdInspectionsDetailIdParams ¶
type GetVesselIdInspectionsDetailIdParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdInspectionsDetailIdParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdInspectionsDetailIdParams defines parameters for GetVesselIdInspectionsDetailId.
type GetVesselIdInspectionsDetailIdParamsFilterIdType ¶
type GetVesselIdInspectionsDetailIdParamsFilterIdType string
GetVesselIdInspectionsDetailIdParamsFilterIdType defines parameters for GetVesselIdInspectionsDetailId.
const ( GetVesselIdInspectionsDetailIdParamsFilterIdTypeImo GetVesselIdInspectionsDetailIdParamsFilterIdType = "imo" GetVesselIdInspectionsDetailIdParamsFilterIdTypeMmsi GetVesselIdInspectionsDetailIdParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdInspectionsDetailIdParamsFilterIdType.
type GetVesselIdInspectionsDetailIdResponse ¶
type GetVesselIdInspectionsDetailIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TypesInspectionDetailResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdInspectionsDetailIdResponse ¶
func ParseGetVesselIdInspectionsDetailIdResponse(rsp *http.Response) (*GetVesselIdInspectionsDetailIdResponse, error)
ParseGetVesselIdInspectionsDetailIdResponse parses an HTTP response from a GetVesselIdInspectionsDetailIdWithResponse call
func (GetVesselIdInspectionsDetailIdResponse) Status ¶
func (r GetVesselIdInspectionsDetailIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdInspectionsDetailIdResponse) StatusCode ¶
func (r GetVesselIdInspectionsDetailIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdInspectionsParams ¶
type GetVesselIdInspectionsParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdInspectionsParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdInspectionsParams defines parameters for GetVesselIdInspections.
type GetVesselIdInspectionsParamsFilterIdType ¶
type GetVesselIdInspectionsParamsFilterIdType string
GetVesselIdInspectionsParamsFilterIdType defines parameters for GetVesselIdInspections.
const ( GetVesselIdInspectionsParamsFilterIdTypeImo GetVesselIdInspectionsParamsFilterIdType = "imo" GetVesselIdInspectionsParamsFilterIdTypeMmsi GetVesselIdInspectionsParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdInspectionsParamsFilterIdType.
type GetVesselIdInspectionsResponse ¶
type GetVesselIdInspectionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TypesInspectionsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdInspectionsResponse ¶
func ParseGetVesselIdInspectionsResponse(rsp *http.Response) (*GetVesselIdInspectionsResponse, error)
ParseGetVesselIdInspectionsResponse parses an HTTP response from a GetVesselIdInspectionsWithResponse call
func (GetVesselIdInspectionsResponse) Status ¶
func (r GetVesselIdInspectionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdInspectionsResponse) StatusCode ¶
func (r GetVesselIdInspectionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdOwnershipParams ¶
type GetVesselIdOwnershipParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdOwnershipParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdOwnershipParams defines parameters for GetVesselIdOwnership.
type GetVesselIdOwnershipParamsFilterIdType ¶
type GetVesselIdOwnershipParamsFilterIdType string
GetVesselIdOwnershipParamsFilterIdType defines parameters for GetVesselIdOwnership.
const ( GetVesselIdOwnershipParamsFilterIdTypeImo GetVesselIdOwnershipParamsFilterIdType = "imo" GetVesselIdOwnershipParamsFilterIdTypeMmsi GetVesselIdOwnershipParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdOwnershipParamsFilterIdType.
type GetVesselIdOwnershipResponse ¶
type GetVesselIdOwnershipResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TypesOwnershipResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdOwnershipResponse ¶
func ParseGetVesselIdOwnershipResponse(rsp *http.Response) (*GetVesselIdOwnershipResponse, error)
ParseGetVesselIdOwnershipResponse parses an HTTP response from a GetVesselIdOwnershipWithResponse call
func (GetVesselIdOwnershipResponse) Status ¶
func (r GetVesselIdOwnershipResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdOwnershipResponse) StatusCode ¶
func (r GetVesselIdOwnershipResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdParams ¶
type GetVesselIdParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdParams defines parameters for GetVesselId.
type GetVesselIdParamsFilterIdType ¶
type GetVesselIdParamsFilterIdType string
GetVesselIdParamsFilterIdType defines parameters for GetVesselId.
const ( GetVesselIdParamsFilterIdTypeImo GetVesselIdParamsFilterIdType = "imo" GetVesselIdParamsFilterIdTypeMmsi GetVesselIdParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdParamsFilterIdType.
type GetVesselIdPositionParams ¶
type GetVesselIdPositionParams struct {
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselIdPositionParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}
GetVesselIdPositionParams defines parameters for GetVesselIdPosition.
type GetVesselIdPositionParamsFilterIdType ¶
type GetVesselIdPositionParamsFilterIdType string
GetVesselIdPositionParamsFilterIdType defines parameters for GetVesselIdPosition.
const ( GetVesselIdPositionParamsFilterIdTypeImo GetVesselIdPositionParamsFilterIdType = "imo" GetVesselIdPositionParamsFilterIdTypeMmsi GetVesselIdPositionParamsFilterIdType = "mmsi" )
Defines values for GetVesselIdPositionParamsFilterIdType.
type GetVesselIdPositionResponse ¶
type GetVesselIdPositionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselPositionResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdPositionResponse ¶
func ParseGetVesselIdPositionResponse(rsp *http.Response) (*GetVesselIdPositionResponse, error)
ParseGetVesselIdPositionResponse parses an HTTP response from a GetVesselIdPositionWithResponse call
func (GetVesselIdPositionResponse) Status ¶
func (r GetVesselIdPositionResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdPositionResponse) StatusCode ¶
func (r GetVesselIdPositionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselIdResponse ¶
type GetVesselIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON404 *NotFoundErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselIdResponse ¶
func ParseGetVesselIdResponse(rsp *http.Response) (*GetVesselIdResponse, error)
ParseGetVesselIdResponse parses an HTTP response from a GetVesselIdWithResponse call
func (GetVesselIdResponse) Status ¶
func (r GetVesselIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselIdResponse) StatusCode ¶
func (r GetVesselIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVesselsPositionsParams ¶
type GetVesselsPositionsParams struct {
// FilterIds Comma-separated list of MMSI or IMO numbers
FilterIds string `form:"filter.ids" json:"filter.ids"`
// FilterIdType Identifier type: 'mmsi' or 'imo'
FilterIdType GetVesselsPositionsParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`
// TimeTo End timestamp in RFC3339 format (defaults to current time)
TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`
// PaginationLimit Maximum number of items to return, must be between 1 and 50
PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`
// PaginationNextToken Pagination token for retrieving the next page of results
PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}
GetVesselsPositionsParams defines parameters for GetVesselsPositions.
type GetVesselsPositionsParamsFilterIdType ¶
type GetVesselsPositionsParamsFilterIdType string
GetVesselsPositionsParamsFilterIdType defines parameters for GetVesselsPositions.
const ( GetVesselsPositionsParamsFilterIdTypeImo GetVesselsPositionsParamsFilterIdType = "imo" GetVesselsPositionsParamsFilterIdTypeMmsi GetVesselsPositionsParamsFilterIdType = "mmsi" )
Defines values for GetVesselsPositionsParamsFilterIdType.
type GetVesselsPositionsResponse ¶
type GetVesselsPositionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *VesselPositionsResponse
JSON400 *BadRequestErrorResponse
JSON401 *AuthenticationErrorResponse
JSON429 *RateLimitErrorResponse
JSON500 *InternalServerErrorResponse
}
func ParseGetVesselsPositionsResponse ¶
func ParseGetVesselsPositionsResponse(rsp *http.Response) (*GetVesselsPositionsResponse, error)
ParseGetVesselsPositionsResponse parses an HTTP response from a GetVesselsPositionsWithResponse call
func (GetVesselsPositionsResponse) Status ¶
func (r GetVesselsPositionsResponse) Status() string
Status returns HTTPResponse.Status
func (GetVesselsPositionsResponse) StatusCode ¶
func (r GetVesselsPositionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GithubComVesselapiCommonVesselDataContractsTypesBroadcastStation ¶
type GithubComVesselapiCommonVesselDataContractsTypesBroadcastStation struct {
// Country Country where the station is located
Country *string `json:"country,omitempty"`
// Coverage Description of the broadcast coverage area
Coverage *string `json:"coverage,omitempty"`
// Latitude Geographic latitude of the station
Latitude *float64 `json:"latitude,omitempty"`
// Longitude Geographic longitude of the station
Longitude *float64 `json:"longitude,omitempty"`
// Name Station name
Name *string `json:"name,omitempty"`
// StationId StationID Unique station identifier character
StationId *string `json:"station_id,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesBroadcastStation NAVTEX radio broadcast station details
type GithubComVesselapiCommonVesselDataContractsTypesClassificationCertificate ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationCertificate struct {
// Certificate Certificate name
Certificate *string `json:"certificate,omitempty"`
// Code Certificate code identifier
Code *string `json:"code,omitempty"`
// Expires Expiry date of the certificate
Expires *string `json:"expires,omitempty"`
// ExtUntil Extended validity date
ExtUntil *string `json:"extUntil,omitempty"`
// Issued Issue date of the certificate
Issued *string `json:"issued,omitempty"`
// Term Certificate validity term
Term *string `json:"term,omitempty"`
// Type Certificate type classification
Type *string `json:"type,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationCertificate Vessel classification certificate record
type GithubComVesselapiCommonVesselDataContractsTypesClassificationCondition ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationCondition struct {
// Condition Condition description text
Condition *string `json:"condition,omitempty"`
// DueDate Date by which the condition must be met
DueDate *string `json:"dueDate,omitempty"`
// ImposedDate Date when the condition was imposed
ImposedDate *string `json:"imposedDate,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationCondition Classification condition of class imposed on a vessel
type GithubComVesselapiCommonVesselDataContractsTypesClassificationDimensions ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationDimensions struct {
// Bm Breadth moulded in meters
Bm *float32 `json:"bm,omitempty"`
// Dm Depth moulded in meters
Dm *float32 `json:"dm,omitempty"`
// Draught Maximum draught in meters
Draught *float32 `json:"draught,omitempty"`
// Dwt Deadweight tonnage in metric tonnes
Dwt *float32 `json:"dwt,omitempty"`
// GrossTon69 Gross tonnage under 1969 convention
GrossTon69 *float32 `json:"grossTon69,omitempty"`
// Lbp Length between perpendiculars in meters
Lbp *float32 `json:"lbp,omitempty"`
// LengthOverall Overall length of the vessel in meters
LengthOverall *float32 `json:"lengthOverall,omitempty"`
// NetTon69 Net tonnage under 1969 convention
NetTon69 *float32 `json:"netTon69,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationDimensions Vessel dimensional measurements from classification records
type GithubComVesselapiCommonVesselDataContractsTypesClassificationHull ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationHull struct {
// DecksNumber Number of decks
DecksNumber *string `json:"decksNumber,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationHull Vessel hull construction details
type GithubComVesselapiCommonVesselDataContractsTypesClassificationIdentification ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationIdentification struct {
// ClassStatusString Current class status description
ClassStatusString *string `json:"classStatusString,omitempty"`
// FlagCode ISO country code of flag state
FlagCode *string `json:"flagCode,omitempty"`
// FlagName Full name of the flag state
FlagName *string `json:"flagName,omitempty"`
// HomePort Port of registry
HomePort *string `json:"homePort,omitempty"`
// ImoNumber IMO number as string
ImoNumber *string `json:"imoNumber,omitempty"`
// NonClassRelationString Non-class relation status description
NonClassRelationString *string `json:"nonClassRelationString,omitempty"`
// OfficialNumber Official registration number
OfficialNumber *string `json:"officialNumber,omitempty"`
// OperationalStatusString Current operational status description
OperationalStatusString *string `json:"operationalStatusString,omitempty"`
// Purposes List of vessel purpose designations
Purposes *[]GithubComVesselapiCommonVesselDataContractsTypesClassificationPurpose `json:"purposes,omitempty"`
// Register Classification register identifier
Register *string `json:"register,omitempty"`
// SignalLetters Radio call sign letters
SignalLetters *string `json:"signalLetters,omitempty"`
// TypeFormatted Formatted vessel type description
TypeFormatted *string `json:"typeFormatted,omitempty"`
// VesselId Classification society vessel identifier
VesselId *string `json:"vesselId,omitempty"`
// VesselName Vessel name in classification records
VesselName *string `json:"vesselName,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationIdentification Vessel identification details from classification society records
type GithubComVesselapiCommonVesselDataContractsTypesClassificationInfo ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationInfo struct {
// ClassEntryDate Date when the vessel entered class
ClassEntryDate *string `json:"classEntryDate,omitempty"`
// ClassNotationString Full class notation string
ClassNotationString *string `json:"classNotationString,omitempty"`
// ClassNotationStringDesign Design class notation string
ClassNotationStringDesign *string `json:"classNotationStringDesign,omitempty"`
// ClassNotationStringInOperation In-operation class notation string
ClassNotationStringInOperation *string `json:"classNotationStringInOperation,omitempty"`
// ClassNotationStringMain Main class notation string
ClassNotationStringMain *string `json:"classNotationStringMain,omitempty"`
// ConstructionSymbol Construction symbol designation
ConstructionSymbol *string `json:"constructionSymbol,omitempty"`
// DualClass Dual classification society designation
DualClass *string `json:"dualClass,omitempty"`
// EquipmentNumber Equipment number from classification
EquipmentNumber *string `json:"equipmentNumber,omitempty"`
// LastClassificationSociety Previous classification society name
LastClassificationSociety *string `json:"lastClassificationSociety,omitempty"`
// MainClass Main class designation
MainClass *string `json:"mainClass,omitempty"`
// MainClassMachinery Main class machinery designation
MainClassMachinery *string `json:"mainClassMachinery,omitempty"`
// RegisterNotationString Register notation string
RegisterNotationString *string `json:"registerNotationString,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationInfo Classification society notation and status information
type GithubComVesselapiCommonVesselDataContractsTypesClassificationMachinery ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationMachinery struct {
// MainPropulsion Main propulsion type description
MainPropulsion *string `json:"mainPropulsion,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationMachinery Vessel machinery and propulsion details
type GithubComVesselapiCommonVesselDataContractsTypesClassificationOwner ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationOwner struct {
// DocHolderDnvId DOC holder DNV identifier
DocHolderDnvId *string `json:"docHolderDnvId,omitempty"`
// DocHolderImoNumber DOC holder IMO company number
DocHolderImoNumber *string `json:"docHolderImoNumber,omitempty"`
// DocHolderName DOC holder company name
DocHolderName *string `json:"docHolderName,omitempty"`
// ManagerDnvId Ship manager DNV identifier
ManagerDnvId *string `json:"managerDnvId,omitempty"`
// ManagerImoNumber Ship manager IMO company number
ManagerImoNumber *string `json:"managerImoNumber,omitempty"`
// ManagerName Ship manager company name
ManagerName *string `json:"managerName,omitempty"`
// OwnerDnvId Registered owner DNV identifier
OwnerDnvId *string `json:"ownerDnvId,omitempty"`
// OwnerImoNumber Registered owner IMO company number
OwnerImoNumber *string `json:"ownerImoNumber,omitempty"`
// OwnerName Registered owner company name
OwnerName *string `json:"ownerName,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationOwner Vessel owner and management company details from classification records
type GithubComVesselapiCommonVesselDataContractsTypesClassificationPurpose ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationPurpose struct {
// Description Detailed purpose description
Description *string `json:"description,omitempty"`
// IsMainPurpose Whether this is the primary vessel purpose
IsMainPurpose *bool `json:"isMainPurpose,omitempty"`
// Purpose Purpose code or short name
Purpose *string `json:"purpose,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationPurpose Vessel purpose designation from classification records
type GithubComVesselapiCommonVesselDataContractsTypesClassificationSurvey ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationSurvey struct {
// Category Survey category classification
Category *string `json:"category,omitempty"`
// DueFrom Earliest date the survey may be performed
DueFrom *string `json:"dueFrom,omitempty"`
// DueTo Latest date the survey must be completed
DueTo *string `json:"dueTo,omitempty"`
// LastDate Date of the most recent survey
LastDate *string `json:"lastDate,omitempty"`
// Location Location where the survey was performed
Location *string `json:"location,omitempty"`
// Postponed Postponement date if the survey was deferred
Postponed *string `json:"postponed,omitempty"`
// Survey Survey type name
Survey *string `json:"survey,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationSurvey Survey record from classification society
type GithubComVesselapiCommonVesselDataContractsTypesClassificationYard ¶
type GithubComVesselapiCommonVesselDataContractsTypesClassificationYard struct {
// ContractedBuilder Contracted shipbuilder name
ContractedBuilder *string `json:"contractedBuilder,omitempty"`
// ContractedBuilderBuildNo Build number assigned by the contracted builder
ContractedBuilderBuildNo *string `json:"contractedBuilderBuildNo,omitempty"`
// DateOfBuild Date when construction was completed
DateOfBuild *string `json:"dateOfBuild,omitempty"`
// HullYardBuildNo Build number assigned by the hull yard
HullYardBuildNo *string `json:"hullYardBuildNo,omitempty"`
// HullYardName Name of the hull construction yard
HullYardName *string `json:"hullYardName,omitempty"`
// KeelDate Keel laying date
KeelDate *string `json:"keelDate,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesClassificationYard Shipyard and construction details from classification records
type GithubComVesselapiCommonVesselDataContractsTypesGeoJSON ¶
type GithubComVesselapiCommonVesselDataContractsTypesGeoJSON struct {
// Coordinates Array of [longitude, latitude] in decimal degrees
Coordinates *[]float32 `json:"coordinates,omitempty"`
// Type GeoJSON geometry type, always "Point" for location data
Type *string `json:"type,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesGeoJSON GeoJSON Point geometry for geospatial coordinates
type GithubComVesselapiCommonVesselDataContractsTypesPortCountry ¶
type GithubComVesselapiCommonVesselDataContractsTypesPortCountry struct {
// Code ISO 2-letter country code
Code *string `json:"code,omitempty"`
// Name Full country name
Name *string `json:"name,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesPortCountry Country information for port location
type GithubComVesselapiCommonVesselDataContractsTypesPortReference ¶
type GithubComVesselapiCommonVesselDataContractsTypesPortReference struct {
// Country Country where the port is located
Country *string `json:"country,omitempty"`
// Name The port's official name
Name *string `json:"name,omitempty"`
// UnloCode UN Location Code (LOCODE) for the port
UnloCode *string `json:"unlo_code,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesPortReference Port identification details for port event reference
type GithubComVesselapiCommonVesselDataContractsTypesVesselFormerName ¶
type GithubComVesselapiCommonVesselDataContractsTypesVesselFormerName struct {
// Name Previous name of the vessel
Name *string `json:"name,omitempty"`
// YearUntil Year until which this name was used
YearUntil *string `json:"year_until,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesVesselFormerName Historical vessel name record
type GithubComVesselapiCommonVesselDataContractsTypesVesselReference ¶
type GithubComVesselapiCommonVesselDataContractsTypesVesselReference struct {
// Imo IMO International Maritime Organization number
Imo *int `json:"imo,omitempty"`
// Mmsi MMSI Maritime Mobile Service Identity number
Mmsi *int `json:"mmsi,omitempty"`
// Name The vessel's registered name
Name *string `json:"name,omitempty"`
}
GithubComVesselapiCommonVesselDataContractsTypesVesselReference Vessel identification details for port event reference
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type InternalServerErrorDetail ¶
type InternalServerErrorDetail struct {
// Code is a short string identifier for this error for programmatic handling
Code *ErrorCode `json:"code,omitempty"`
// ErrorId ErrorID is a unique identifier for tracking this error (always present for 500 errors)
ErrorId *string `json:"error_id,omitempty"`
// Message is a human-readable message providing more details about the error
Message *string `json:"message,omitempty"`
// Timestamp when the error occurred (ISO 8601 format)
Timestamp *string `json:"timestamp,omitempty"`
// Type categorizes the error (always "api_error" for 500s)
Type *ErrorType `json:"type,omitempty"`
}
InternalServerErrorDetail Detailed internal server error information
type InternalServerErrorResponse ¶
type InternalServerErrorResponse struct {
// Error Detailed internal server error information
Error *InternalServerErrorDetail `json:"error,omitempty"`
}
InternalServerErrorResponse Response returned for internal server errors (HTTP 500)
type Iterator ¶
type Iterator[T any] struct { // contains filtered or unexported fields }
Iterator provides lazy, sequential access to paginated API results. Use Next to advance, Value to read the current item, and Err to check for errors. Collect returns all remaining items.
type LightAid ¶
type LightAid struct {
// AidType Type of navigational aid (Light, Buoy, Beacon, etc.)
AidType *string `json:"aid_type,omitempty"`
// Characteristic Light flash pattern description (e.g., Fl W 7.5s)
Characteristic *string `json:"characteristic,omitempty"`
// CharacteristicNumber Light characteristic code number
CharacteristicNumber *int `json:"characteristic_number,omitempty"`
// DeleteFlag Deletion status flag
DeleteFlag *string `json:"delete_flag,omitempty"`
// FeatureNumber NGA feature number identifier
FeatureNumber *string `json:"feature_number,omitempty"`
// GeopoliticalHeading Country or major geographic area
GeopoliticalHeading *string `json:"geopolitical_heading,omitempty"`
// HeightFeetMeters Height of light above water in feet and meters
HeightFeetMeters *string `json:"height_feet_meters,omitempty"`
// LocalHeading Local area description
LocalHeading *string `json:"local_heading,omitempty"`
// Location GeoJSON point for geospatial queries
Location *GithubComVesselapiCommonVesselDataContractsTypesGeoJSON `json:"location,omitempty"`
// Name Name of the light aid
Name *string `json:"name,omitempty"`
// NoticeNumber Notice to Mariners number
NoticeNumber *int `json:"notice_number,omitempty"`
// NoticeWeek Week of the notice
NoticeWeek *string `json:"notice_week,omitempty"`
// NoticeYear Year of the notice
NoticeYear *string `json:"notice_year,omitempty"`
// Position Human-readable position description
Position *string `json:"position,omitempty"`
// PostNote Notes appearing after the main entry
PostNote *string `json:"post_note,omitempty"`
// PrecedingNote Notes appearing before the main entry
PrecedingNote *string `json:"preceding_note,omitempty"`
// Range Nominal range of light in nautical miles
Range *string `json:"range,omitempty"`
// RegionHeading Regional geographic subdivision
RegionHeading *string `json:"region_heading,omitempty"`
// Remarks Additional remarks about the light
Remarks *string `json:"remarks,omitempty"`
// RemoveFromList Flag indicating if entry should be removed
RemoveFromList *string `json:"remove_from_list,omitempty"`
// Structure Description of the physical structure
Structure *string `json:"structure,omitempty"`
// SubregionHeading Sub-regional geographic area
SubregionHeading *string `json:"subregion_heading,omitempty"`
// VolumeNumber NGA publication volume number
VolumeNumber *string `json:"volume_number,omitempty"`
}
LightAid Navigational light aid including lighthouses, buoys, and beacons
type LightAidsWithinLocationResponse ¶
type LightAidsWithinLocationResponse struct {
// LightAids List of light aids within the specified area
LightAids *[]LightAid `json:"lightAids,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
LightAidsWithinLocationResponse Response containing light aids within location data
type LocationService ¶
type LocationService struct {
// contains filtered or unexported fields
}
LocationService wraps location-based API endpoints.
func (*LocationService) AllDGPSBoundingBox ¶
func (s *LocationService) AllDGPSBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams) *Iterator[DGPSStation]
AllDGPSBoundingBox returns an iterator over all DGPS stations in a bounding box.
func (*LocationService) AllDGPSRadius ¶
func (s *LocationService) AllDGPSRadius(ctx context.Context, params *GetLocationDgpsRadiusParams) *Iterator[DGPSStation]
AllDGPSRadius returns an iterator over all DGPS stations within a radius.
func (*LocationService) AllLightAidsBoundingBox ¶
func (s *LocationService) AllLightAidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams) *Iterator[LightAid]
AllLightAidsBoundingBox returns an iterator over all light aids in a bounding box.
func (*LocationService) AllLightAidsRadius ¶
func (s *LocationService) AllLightAidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams) *Iterator[LightAid]
AllLightAidsRadius returns an iterator over all light aids within a radius.
func (*LocationService) AllMODUsBoundingBox ¶
func (s *LocationService) AllMODUsBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams) *Iterator[MODU]
AllMODUsBoundingBox returns an iterator over all MODUs in a bounding box.
func (*LocationService) AllMODUsRadius ¶
func (s *LocationService) AllMODUsRadius(ctx context.Context, params *GetLocationModuRadiusParams) *Iterator[MODU]
AllMODUsRadius returns an iterator over all MODUs within a radius.
func (*LocationService) AllPortsBoundingBox ¶
func (s *LocationService) AllPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams) *Iterator[Port]
AllPortsBoundingBox returns an iterator over all ports in a bounding box.
func (*LocationService) AllPortsRadius ¶
func (s *LocationService) AllPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams) *Iterator[Port]
AllPortsRadius returns an iterator over all ports within a radius.
func (*LocationService) AllRadioBeaconsBoundingBox ¶
func (s *LocationService) AllRadioBeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams) *Iterator[RadioBeacon]
AllRadioBeaconsBoundingBox returns an iterator over all radio beacons in a bounding box.
func (*LocationService) AllRadioBeaconsRadius ¶
func (s *LocationService) AllRadioBeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams) *Iterator[RadioBeacon]
AllRadioBeaconsRadius returns an iterator over all radio beacons within a radius.
func (*LocationService) AllVesselsBoundingBox ¶
func (s *LocationService) AllVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams) *Iterator[VesselPosition]
AllVesselsBoundingBox returns an iterator over all vessel positions in a bounding box.
func (*LocationService) AllVesselsRadius ¶
func (s *LocationService) AllVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams) *Iterator[VesselPosition]
AllVesselsRadius returns an iterator over all vessel positions within a radius.
func (*LocationService) DGPSBoundingBox ¶
func (s *LocationService) DGPSBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams) (*DGPSStationsWithinLocationResponse, error)
DGPSBoundingBox retrieves DGPS stations within a bounding box.
func (*LocationService) DGPSRadius ¶
func (s *LocationService) DGPSRadius(ctx context.Context, params *GetLocationDgpsRadiusParams) (*DGPSStationsWithinLocationResponse, error)
DGPSRadius retrieves DGPS stations within a radius.
func (*LocationService) LightAidsBoundingBox ¶
func (s *LocationService) LightAidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams) (*LightAidsWithinLocationResponse, error)
LightAidsBoundingBox retrieves light aids within a bounding box.
func (*LocationService) LightAidsRadius ¶
func (s *LocationService) LightAidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams) (*LightAidsWithinLocationResponse, error)
LightAidsRadius retrieves light aids within a radius.
func (*LocationService) MODUsBoundingBox ¶
func (s *LocationService) MODUsBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams) (*MODUsWithinLocationResponse, error)
MODUsBoundingBox retrieves MODUs within a bounding box.
func (*LocationService) MODUsRadius ¶
func (s *LocationService) MODUsRadius(ctx context.Context, params *GetLocationModuRadiusParams) (*MODUsWithinLocationResponse, error)
MODUsRadius retrieves MODUs within a radius.
func (*LocationService) PortsBoundingBox ¶
func (s *LocationService) PortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams) (*PortsWithinLocationResponse, error)
PortsBoundingBox retrieves ports within a bounding box.
func (*LocationService) PortsRadius ¶
func (s *LocationService) PortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams) (*PortsWithinLocationResponse, error)
PortsRadius retrieves ports within a radius.
func (*LocationService) RadioBeaconsBoundingBox ¶
func (s *LocationService) RadioBeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams) (*RadioBeaconsWithinLocationResponse, error)
RadioBeaconsBoundingBox retrieves radio beacons within a bounding box.
func (*LocationService) RadioBeaconsRadius ¶
func (s *LocationService) RadioBeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams) (*RadioBeaconsWithinLocationResponse, error)
RadioBeaconsRadius retrieves radio beacons within a radius.
func (*LocationService) VesselsBoundingBox ¶
func (s *LocationService) VesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams) (*VesselsWithinLocationResponse, error)
VesselsBoundingBox retrieves vessel positions within a bounding box.
func (*LocationService) VesselsRadius ¶
func (s *LocationService) VesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams) (*VesselsWithinLocationResponse, error)
VesselsRadius retrieves vessel positions within a radius.
type MODU ¶
type MODU struct {
// Date Date of the position report (parsed from API string format YYYY-MM-DD)
Date *string `json:"date,omitempty"`
// Distance Distance from reference point in nautical miles
Distance *float32 `json:"distance,omitempty"`
// Latitude Geographic latitude in decimal degrees
Latitude *float64 `json:"latitude,omitempty"`
// Location GeoJSON point for geospatial queries
Location *GithubComVesselapiCommonVesselDataContractsTypesGeoJSON `json:"location,omitempty"`
// Longitude Geographic longitude in decimal degrees
Longitude *float64 `json:"longitude,omitempty"`
// Name Name of the drilling unit
Name *string `json:"name,omitempty"`
NavigationArea *string `json:"navigation_area,omitempty"`
// Position Human-readable position description
Position *string `json:"position,omitempty"`
// Region NGA region code
Region *int `json:"region,omitempty"`
// RigStatus Current operational status of the rig
RigStatus *string `json:"rig_status,omitempty"`
// SpecialStatus Any special status or notes
SpecialStatus *string `json:"special_status,omitempty"`
// SubRegion NGA sub-region code
SubRegion *int `json:"sub_region,omitempty"`
}
MODU Mobile Offshore Drilling Unit (MODU) location and status information
type MODUsWithinLocationResponse ¶
type MODUsWithinLocationResponse struct {
// Modus List of MODUs within the specified area
Modus *[]MODU `json:"modus,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
MODUsWithinLocationResponse Response containing MODUs within location data
type MarineCasualtiesResponse ¶
type MarineCasualtiesResponse struct {
// Casualties List of marine casualty records
Casualties *[]MarineCasualty `json:"casualties,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
MarineCasualtiesResponse Response containing marine casualty data
type MarineCasualty ¶
type MarineCasualty struct {
// AtCoding Accident type taxonomy codes
AtCoding *[]string `json:"atCoding,omitempty"`
// CasualtyReportNr Casualty report reference number
CasualtyReportNr *string `json:"casualtyReportNr,omitempty"`
// CfCoding Contributory factor taxonomy codes
CfCoding *[]string `json:"cfCoding,omitempty"`
// CollectedAt Metadata (set by collector, not from API)
CollectedAt *string `json:"collectedAt,omitempty"`
// CompetentAuthority Competent maritime authorities involved
CompetentAuthority *[]string `json:"competentAuthority,omitempty"`
// DateOfOccurrence Event details
DateOfOccurrence *string `json:"dateOfOccurrence,omitempty"`
// Deviation Deviation event taxonomy codes
Deviation *[]string `json:"deviation,omitempty"`
// EventType Type of marine event classifications
EventType *[]string `json:"eventType,omitempty"`
// FinishedInvestigation Whether the investigation has been completed
FinishedInvestigation *bool `json:"finishedInvestigation,omitempty"`
// ImoNr IMO numbers of vessels involved
ImoNr *[]string `json:"imoNr,omitempty"`
// InterimReport Whether an interim report has been published
InterimReport *bool `json:"interimReport,omitempty"`
// InvestigatingState Investigation
InvestigatingState *string `json:"investigatingState,omitempty"`
// LivesLostTotal Consequences
LivesLostTotal *string `json:"livesLostTotal,omitempty"`
// NameOfShip Vessel info (arrays since multiple vessels can be involved)
NameOfShip *[]string `json:"nameOfShip,omitempty"`
// OccurrenceSeverity Severity classification of the occurrence
OccurrenceSeverity *string `json:"occurrenceSeverity,omitempty"`
// OccurrenceUuid External IDs
OccurrenceUuid *string `json:"occurrenceUuid,omitempty"`
// OccurrenceWithPersons Person-related event taxonomy codes
OccurrenceWithPersons *[]string `json:"occurrenceWithPersons,omitempty"`
// OccurrenceWithShips Taxonomy classifications
OccurrenceWithShips *[]string `json:"occurrenceWithShips,omitempty"`
// PeopleInjuredTotal Total number of people injured
PeopleInjuredTotal *string `json:"peopleInjuredTotal,omitempty"`
// Pollution Whether pollution resulted from the casualty
Pollution *bool `json:"pollution,omitempty"`
// ShipCraftType Ship/craft type classifications of involved vessels
ShipCraftType *[]string `json:"shipCraftType,omitempty"`
// SrCoding Safety recommendation taxonomy codes
SrCoding *[]string `json:"srCoding,omitempty"`
}
MarineCasualty Marine casualty occurrence record from the European Marine Casualty Information Platform
type Navtex ¶
type Navtex struct {
IssuingOffice *string `json:"issuing_office,omitempty"`
Label *string `json:"label,omitempty"`
Lines *[]string `json:"lines,omitempty"`
MetareaCoordinator *string `json:"metarea_coordinator,omitempty"`
MetareaId *string `json:"metarea_id,omitempty"`
MetareaName *string `json:"metarea_name,omitempty"`
MetareaRegion *string `json:"metarea_region,omitempty"`
MetareaStations *[]GithubComVesselapiCommonVesselDataContractsTypesBroadcastStation `json:"metarea_stations,omitempty"`
RawContent *string `json:"raw_content,omitempty"`
Timestamp *string `json:"timestamp,omitempty"`
WmoHeader *string `json:"wmo_header,omitempty"`
}
Navtex NAVTEX maritime safety information broadcast message
type NavtexMessagesResponse ¶
type NavtexMessagesResponse struct {
NavtexMessages *[]Navtex `json:"navtexMessages,omitempty"`
NextToken *string `json:"nextToken,omitempty"`
}
NavtexMessagesResponse Response containing NAVTEX message data
type NavtexService ¶
type NavtexService struct {
// contains filtered or unexported fields
}
NavtexService wraps NAVTEX message API endpoints.
func (*NavtexService) List ¶
func (s *NavtexService) List(ctx context.Context, params *GetNavtexParams) (*NavtexMessagesResponse, error)
List retrieves NAVTEX maritime safety messages.
func (*NavtexService) ListAll ¶
func (s *NavtexService) ListAll(ctx context.Context, params *GetNavtexParams) *Iterator[Navtex]
ListAll returns an iterator over all NAVTEX messages.
type NotFoundErrorDetail ¶
type NotFoundErrorDetail struct {
// Code is a short string identifier for this error for programmatic handling
Code *ErrorCode `json:"code,omitempty"`
// Message is a human-readable message providing more details about the error
Message *string `json:"message,omitempty"`
// Type categorizes the error (always "not_found_error" for 404s)
Type *ErrorType `json:"type,omitempty"`
}
NotFoundErrorDetail Detailed not found error information
type NotFoundErrorResponse ¶
type NotFoundErrorResponse struct {
// Error Detailed not found error information
Error *NotFoundErrorDetail `json:"error,omitempty"`
}
NotFoundErrorResponse Response returned when the requested resource is not found (HTTP 404)
type Port ¶
type Port struct {
// AnchorageDepth Depth at the anchorage area
AnchorageDepth *float32 `json:"anchorage_depth,omitempty"`
// AnchorageDepthUnit Unit for anchorage depth measurement
AnchorageDepthUnit *string `json:"anchorage_depth_unit,omitempty"`
// CargoHandlingDepth Depth at cargo handling berths
CargoHandlingDepth *float32 `json:"cargo_handling_depth,omitempty"`
// CargoHandlingDepthUnit Unit for cargo handling depth measurement
CargoHandlingDepthUnit *string `json:"cargo_handling_depth_unit,omitempty"`
// ChannelDepth Depth of the approach channel
ChannelDepth *float32 `json:"channel_depth,omitempty"`
// ChannelDepthUnit Unit for channel depth measurement
ChannelDepthUnit *string `json:"channel_depth_unit,omitempty"`
// Country Country information for the port
Country *GithubComVesselapiCommonVesselDataContractsTypesPortCountry `json:"country,omitempty"`
// GarbageDisposal Whether garbage disposal services are available
GarbageDisposal *bool `json:"garbage_disposal,omitempty"`
// HarborSize Harbor size classification (Large/Medium/Small/Very Small)
HarborSize *string `json:"harbor_size,omitempty"`
// HarborType Type of harbor (CB=Coastal Breakwater, CN=Coastal Natural, etc.)
HarborType *string `json:"harbor_type,omitempty"`
// HarborUse Primary use of the harbor (FISH/MIL/CARGO/FERRY/UNK)
HarborUse *string `json:"harbor_use,omitempty"`
// HasDrydock Whether the port has drydock facilities
HasDrydock *bool `json:"has_drydock,omitempty"`
// Latitude Geographic latitude in decimal degrees
Latitude *float64 `json:"latitude,omitempty"`
// Location GeoJSON point for geospatial queries
Location *GithubComVesselapiCommonVesselDataContractsTypesGeoJSON `json:"location,omitempty"`
// Longitude Geographic longitude in decimal degrees
Longitude *float64 `json:"longitude,omitempty"`
// MaxVesselBeam Maximum beam (width) of vessel that can be accommodated
MaxVesselBeam *float32 `json:"max_vessel_beam,omitempty"`
// MaxVesselBeamUnit Unit for maximum vessel beam
MaxVesselBeamUnit *string `json:"max_vessel_beam_unit,omitempty"`
// MaxVesselDraft Maximum draft of vessel that can be accommodated
MaxVesselDraft *float32 `json:"max_vessel_draft,omitempty"`
// MaxVesselDraftUnit Unit for maximum vessel draft
MaxVesselDraftUnit *string `json:"max_vessel_draft_unit,omitempty"`
// MaxVesselLength Maximum length of vessel that can be accommodated
MaxVesselLength *float32 `json:"max_vessel_length,omitempty"`
// MaxVesselLengthUnit Unit for maximum vessel length
MaxVesselLengthUnit *string `json:"max_vessel_length_unit,omitempty"`
// MedicalFacilities Whether medical facilities are available at the port
MedicalFacilities *bool `json:"medical_facilities,omitempty"`
// Name The port's official name
Name *string `json:"name,omitempty"`
NavigationArea *string `json:"navigation_area,omitempty"`
// PilotageAvailable Whether pilotage services are available
PilotageAvailable *bool `json:"pilotage_available,omitempty"`
// PilotageCompulsory Whether pilotage is mandatory for vessel entry
PilotageCompulsory *bool `json:"pilotage_compulsory,omitempty"`
// PortSecurity Whether ISPS (International Ship and Port Facility Security) compliant
PortSecurity *bool `json:"port_security,omitempty"`
// RegionName Geographic region where the port is located
RegionName *string `json:"region_name,omitempty"`
// RepairCapability Level of ship repair capability (Major/Moderate/Limited/Emergency/None)
RepairCapability *string `json:"repair_capability,omitempty"`
// Shelter Quality of shelter from weather (Excellent/Good/Fair/Poor/None)
Shelter *string `json:"shelter,omitempty"`
// Size Size classification of the port
Size *string `json:"size,omitempty"`
// SupplyDiesel Whether diesel supply is available
SupplyDiesel *bool `json:"supply_diesel,omitempty"`
// SupplyFuel Whether fuel oil supply is available
SupplyFuel *bool `json:"supply_fuel,omitempty"`
// SupplyWater Whether fresh water supply is available
SupplyWater *bool `json:"supply_water,omitempty"`
// TrafficSeparationScheme Whether a TSS (Traffic Separation Scheme) is in place
TrafficSeparationScheme *bool `json:"traffic_separation_scheme,omitempty"`
// TugsAvailable Whether tug services are available
TugsAvailable *bool `json:"tugs_available,omitempty"`
// Type Port classification type
Type *string `json:"type,omitempty"`
// UnloCode UN Location Code (LOCODE) - unique port identifier
UnloCode *string `json:"unlo_code,omitempty"`
// VesselTrafficService Whether VTS (Vessel Traffic Service) is operational
VesselTrafficService *bool `json:"vessel_traffic_service,omitempty"`
}
Port Complete port information including facilities, services, and characteristics
type PortEvent ¶
type PortEvent struct {
// Event Type of port event - either "Arrival" or "Departure"
Event *string `json:"event,omitempty"`
// Port Reference to the port where the event occurred
Port *GithubComVesselapiCommonVesselDataContractsTypesPortReference `json:"port,omitempty"`
// Timestamp UTC timestamp when the event occurred
Timestamp *string `json:"timestamp,omitempty"`
// Vessel Reference to the vessel involved in the port event
Vessel *GithubComVesselapiCommonVesselDataContractsTypesVesselReference `json:"vessel,omitempty"`
}
PortEvent Vessel port call event including arrivals and departures
type PortEventResponse ¶
type PortEventResponse struct {
// PortEvent Vessel port call event including arrivals and departures
PortEvent *PortEvent `json:"portEvent,omitempty"`
}
PortEventResponse Response containing a single port event
type PortEventsResponse ¶
type PortEventsResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// PortEvents List of port events
PortEvents *[]PortEvent `json:"portEvents,omitempty"`
}
PortEventsResponse Response containing port event data
type PortEventsService ¶
type PortEventsService struct {
// contains filtered or unexported fields
}
PortEventsService wraps port event API endpoints.
func (*PortEventsService) AllByPort ¶
func (s *PortEventsService) AllByPort(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams) *Iterator[PortEvent]
AllByPort returns an iterator over all port events for a specific port.
func (*PortEventsService) AllByPorts ¶
func (s *PortEventsService) AllByPorts(ctx context.Context, params *GetPorteventsPortsParams) *Iterator[PortEvent]
AllByPorts returns an iterator over all port events by port name search.
func (*PortEventsService) AllByVessel ¶
func (s *PortEventsService) AllByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdParams) *Iterator[PortEvent]
AllByVessel returns an iterator over all port events for a vessel.
func (*PortEventsService) AllByVessels ¶
func (s *PortEventsService) AllByVessels(ctx context.Context, params *GetPorteventsVesselsParams) *Iterator[PortEvent]
AllByVessels returns an iterator over all port events by vessel name search.
func (*PortEventsService) ByPort ¶
func (s *PortEventsService) ByPort(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams) (*PortEventsResponse, error)
ByPort retrieves port events for a specific port by UNLOCODE.
func (*PortEventsService) ByPorts ¶
func (s *PortEventsService) ByPorts(ctx context.Context, params *GetPorteventsPortsParams) (*PortEventsResponse, error)
ByPorts retrieves port events by port name search.
func (*PortEventsService) ByVessel ¶
func (s *PortEventsService) ByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdParams) (*PortEventsResponse, error)
ByVessel retrieves port events for a specific vessel.
func (*PortEventsService) ByVessels ¶
func (s *PortEventsService) ByVessels(ctx context.Context, params *GetPorteventsVesselsParams) (*PortEventsResponse, error)
ByVessels retrieves port events by vessel name search.
func (*PortEventsService) LastByVessel ¶
func (s *PortEventsService) LastByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams) (*PortEventResponse, error)
LastByVessel retrieves the last port event for a vessel.
func (*PortEventsService) List ¶
func (s *PortEventsService) List(ctx context.Context, params *GetPorteventsParams) (*PortEventsResponse, error)
List retrieves port events with optional filtering.
func (*PortEventsService) ListAll ¶
func (s *PortEventsService) ListAll(ctx context.Context, params *GetPorteventsParams) *Iterator[PortEvent]
ListAll returns an iterator over all port events.
type PortResponse ¶
type PortResponse struct {
// Port Complete port information including facilities, services, and characteristics
Port *Port `json:"port,omitempty"`
}
PortResponse Response containing a single port
type PortsService ¶
type PortsService struct {
// contains filtered or unexported fields
}
PortsService wraps port-related API endpoints.
func (*PortsService) Get ¶
func (s *PortsService) Get(ctx context.Context, unlocode string) (*PortResponse, error)
Get retrieves a port by its UN/LOCODE.
type PortsWithinLocationResponse ¶
type PortsWithinLocationResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// Ports List of ports within the specified area
Ports *[]Port `json:"ports,omitempty"`
}
PortsWithinLocationResponse Response containing ports within location data
type RadioBeacon ¶
type RadioBeacon struct {
// AidType Type of radio aid
AidType *string `json:"aid_type,omitempty"`
// Characteristic Beacon transmission characteristic
Characteristic *string `json:"characteristic,omitempty"`
// DeleteFlag Deletion status flag
DeleteFlag *string `json:"delete_flag,omitempty"`
// FeatureNumber NGA feature number identifier
FeatureNumber *int `json:"feature_number,omitempty"`
// Frequency Broadcast frequency
Frequency *string `json:"frequency,omitempty"`
// GeopoliticalHeading Country or major geographic area
GeopoliticalHeading *string `json:"geopolitical_heading,omitempty"`
// Location GeoJSON point for geospatial queries
Location *GithubComVesselapiCommonVesselDataContractsTypesGeoJSON `json:"location,omitempty"`
// Name Name of the radio beacon
Name *string `json:"name,omitempty"`
// NoticeNumber Notice to Mariners number
NoticeNumber *int `json:"notice_number,omitempty"`
// NoticeWeek Week of the notice
NoticeWeek *string `json:"notice_week,omitempty"`
// NoticeYear Year of the notice
NoticeYear *string `json:"notice_year,omitempty"`
// Position Human-readable position description
Position *string `json:"position,omitempty"`
// PostNote Notes appearing after the main entry
PostNote *string `json:"post_note,omitempty"`
// PrecedingNote Notes appearing before the main entry
PrecedingNote *string `json:"preceding_note,omitempty"`
// Range Signal range in nautical miles
Range *string `json:"range,omitempty"`
// RegionHeading Regional geographic subdivision
RegionHeading *string `json:"region_heading,omitempty"`
// RemoveFromList Flag indicating if entry should be removed
RemoveFromList *string `json:"remove_from_list,omitempty"`
// SequenceText Transmission sequence description
SequenceText *string `json:"sequence_text,omitempty"`
// StationRemark Remarks specific to the station
StationRemark *string `json:"station_remark,omitempty"`
// VolumeNumber NGA publication volume number
VolumeNumber *string `json:"volume_number,omitempty"`
}
RadioBeacon Navigational radio beacon for maritime direction finding
type RadioBeaconsWithinLocationResponse ¶
type RadioBeaconsWithinLocationResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// RadioBeacons List of radio beacons within the specified area
RadioBeacons *[]RadioBeacon `json:"radioBeacons,omitempty"`
}
RadioBeaconsWithinLocationResponse Response containing radio beacons within location data
type RateLimitErrorDetail ¶
type RateLimitErrorDetail struct {
// Code is a short string identifier for this error for programmatic handling
Code *ErrorCode `json:"code,omitempty"`
// Message is a human-readable message providing more details about the error
Message *string `json:"message,omitempty"`
// Type categorizes the error (always "rate_limit_error" for 429s)
Type *ErrorType `json:"type,omitempty"`
}
RateLimitErrorDetail Detailed rate limit error information
type RateLimitErrorResponse ¶
type RateLimitErrorResponse struct {
// Error Detailed rate limit error information
Error *RateLimitErrorDetail `json:"error,omitempty"`
}
RateLimitErrorResponse Response returned when the API rate limit is exceeded (HTTP 429)
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SearchService ¶
type SearchService struct {
// contains filtered or unexported fields
}
SearchService wraps search API endpoints.
func (*SearchService) AllDGPS ¶
func (s *SearchService) AllDGPS(ctx context.Context, params *GetSearchDgpsParams) *Iterator[DGPSStation]
AllDGPS returns an iterator over all DGPS station search results.
func (*SearchService) AllLightAids ¶
func (s *SearchService) AllLightAids(ctx context.Context, params *GetSearchLightaidsParams) *Iterator[LightAid]
AllLightAids returns an iterator over all light aid search results.
func (*SearchService) AllMODUs ¶
func (s *SearchService) AllMODUs(ctx context.Context, params *GetSearchModusParams) *Iterator[MODU]
AllMODUs returns an iterator over all MODU search results.
func (*SearchService) AllPorts ¶
func (s *SearchService) AllPorts(ctx context.Context, params *GetSearchPortsParams) *Iterator[Port]
AllPorts returns an iterator over all port search results.
func (*SearchService) AllRadioBeacons ¶
func (s *SearchService) AllRadioBeacons(ctx context.Context, params *GetSearchRadiobeaconsParams) *Iterator[RadioBeacon]
AllRadioBeacons returns an iterator over all radio beacon search results.
func (*SearchService) AllVessels ¶
func (s *SearchService) AllVessels(ctx context.Context, params *GetSearchVesselsParams) *Iterator[Vessel]
AllVessels returns an iterator over all vessel search results.
func (*SearchService) DGPS ¶
func (s *SearchService) DGPS(ctx context.Context, params *GetSearchDgpsParams) (*FindDGPSStationsResponse, error)
DGPS searches for DGPS stations by name.
func (*SearchService) LightAids ¶
func (s *SearchService) LightAids(ctx context.Context, params *GetSearchLightaidsParams) (*FindLightAidsResponse, error)
LightAids searches for light aids by name.
func (*SearchService) MODUs ¶
func (s *SearchService) MODUs(ctx context.Context, params *GetSearchModusParams) (*FindMODUsResponse, error)
MODUs searches for MODUs (Mobile Offshore Drilling Units) by name.
func (*SearchService) Ports ¶
func (s *SearchService) Ports(ctx context.Context, params *GetSearchPortsParams) (*FindPortsResponse, error)
Ports searches for ports by name.
func (*SearchService) RadioBeacons ¶
func (s *SearchService) RadioBeacons(ctx context.Context, params *GetSearchRadiobeaconsParams) (*FindRadioBeaconsResponse, error)
RadioBeacons searches for radio beacons by name.
func (*SearchService) Vessels ¶
func (s *SearchService) Vessels(ctx context.Context, params *GetSearchVesselsParams) (*FindVesselsResponse, error)
Vessels searches for vessels by name or callsign.
type TypesInspection ¶
type TypesInspection struct {
// Authority Port state control authority that conducted the inspection
Authority *string `json:"authority,omitempty"`
// Deficiencies Number of deficiencies found
Deficiencies *int `json:"deficiencies,omitempty"`
// DetailId Unique identifier for retrieving inspection details
DetailId *string `json:"detail_id,omitempty"`
// Detained Whether the vessel was detained
Detained *bool `json:"detained,omitempty"`
// Imo IMO number of the inspected vessel
Imo *int `json:"imo,omitempty"`
// InspectionDate Date when the inspection was conducted
InspectionDate *string `json:"inspection_date,omitempty"`
// InspectionType Type of inspection performed
InspectionType *string `json:"inspection_type,omitempty"`
// MouRegion Memorandum of Understanding region (e.g., Paris MOU, Tokyo MOU)
MouRegion *string `json:"mou_region,omitempty"`
// Port Port where the inspection took place
Port *string `json:"port,omitempty"`
}
TypesInspection Port state control inspection summary record
type TypesInspectionDeficiency ¶
type TypesInspectionDeficiency struct {
// Category Deficiency category classification
Category *string `json:"category,omitempty"`
// Count Number of deficiencies in this category
Count *int `json:"count,omitempty"`
// Deficiency Deficiency description
Deficiency *string `json:"deficiency,omitempty"`
}
TypesInspectionDeficiency Inspection deficiency record with category and count
type TypesInspectionDetail ¶
type TypesInspectionDetail struct {
// Authority Port state control authority that conducted the inspection
Authority *string `json:"authority,omitempty"`
// Deficiencies List of deficiency records
Deficiencies *[]TypesInspectionDeficiency `json:"deficiencies,omitempty"`
// DeficiencyCount Total number of deficiencies found
DeficiencyCount *int `json:"deficiency_count,omitempty"`
// DetailId Unique inspection detail identifier
DetailId *string `json:"detail_id,omitempty"`
// Detained Whether the vessel was detained
Detained *bool `json:"detained,omitempty"`
// DetentionGrounds Grounds for detention if the vessel was detained
DetentionGrounds *[]TypesInspectionDeficiency `json:"detention_grounds,omitempty"`
// Imo IMO number of the inspected vessel
Imo *int `json:"imo,omitempty"`
// InspectionDate Date when the inspection was conducted
InspectionDate *string `json:"inspection_date,omitempty"`
// InspectionType Type of inspection performed
InspectionType *string `json:"inspection_type,omitempty"`
// MouRegion Memorandum of Understanding region
MouRegion *string `json:"mou_region,omitempty"`
// Port Port where the inspection took place
Port *string `json:"port,omitempty"`
}
TypesInspectionDetail Detailed port state control inspection record including deficiencies
type TypesInspectionDetailResponse ¶
type TypesInspectionDetailResponse struct {
// CachedAt UTC timestamp when the data was cached
CachedAt *string `json:"cached_at,omitempty"`
// DetailId Inspection detail identifier
DetailId *string `json:"detail_id,omitempty"`
// Imo IMO number of the vessel
Imo *int `json:"imo,omitempty"`
// InspectionDetail Detailed port state control inspection record including deficiencies
InspectionDetail *TypesInspectionDetail `json:"inspection_detail,omitempty"`
}
TypesInspectionDetailResponse Response containing detailed inspection data
type TypesInspectionsResponse ¶
type TypesInspectionsResponse struct {
// CachedAt UTC timestamp when the data was cached
CachedAt *string `json:"cached_at,omitempty"`
// Imo IMO number of the vessel
Imo *int `json:"imo,omitempty"`
// InspectionCount Total number of inspection records
InspectionCount *int `json:"inspection_count,omitempty"`
// Inspections List of inspection summary records
Inspections *[]TypesInspection `json:"inspections,omitempty"`
}
TypesInspectionsResponse Response containing inspection records for a vessel
type TypesOwnershipResponse ¶
type TypesOwnershipResponse struct {
// CachedAt UTC timestamp when the data was cached
CachedAt *string `json:"cached_at,omitempty"`
// Imo IMO number of the vessel
Imo *int `json:"imo,omitempty"`
// Ownership Vessel ownership and management company details
Ownership *TypesVesselOwnership `json:"ownership,omitempty"`
}
TypesOwnershipResponse Response containing vessel ownership and management data
type TypesVesselOwnership ¶
type TypesVesselOwnership struct {
// DocCompany Document of Compliance (DOC) issuing company
DocCompany *string `json:"doc_company,omitempty"`
// DocCompanyAddress Address of the DOC company
DocCompanyAddress *string `json:"doc_company_address,omitempty"`
// Imo IMO number of the vessel
Imo *int `json:"imo,omitempty"`
// RegisteredOwner Registered owner name
RegisteredOwner *string `json:"registered_owner,omitempty"`
// RegisteredOwnerAddress Address of the registered owner
RegisteredOwnerAddress *string `json:"registered_owner_address,omitempty"`
// ShipManager Ship management company name
ShipManager *string `json:"ship_manager,omitempty"`
// ShipManagerAddress Address of the ship management company
ShipManagerAddress *string `json:"ship_manager_address,omitempty"`
}
TypesVesselOwnership Vessel ownership and management company details
type Vessel ¶
type Vessel struct {
// Breadth Maximum beam (width) of the vessel
Breadth *int `json:"breadth,omitempty"`
// BreadthUnit Unit of measurement for breadth (typically meters)
BreadthUnit *string `json:"breadth_unit,omitempty"`
// Builder Name of the shipyard that built the vessel
Builder *string `json:"builder,omitempty"`
// CallSign International radio call sign assigned to the vessel
CallSign *string `json:"call_sign,omitempty"`
// ClassSociety Classification society responsible for vessel certification
ClassSociety *string `json:"class_society,omitempty"`
// Country Country of registration (flag state)
Country *string `json:"country,omitempty"`
// CountryCode ISO 2-letter country code of flag state
CountryCode *string `json:"country_code,omitempty"`
// DeadweightTonnage Deadweight tonnage (DWT) - maximum cargo capacity in metric tons
DeadweightTonnage *int `json:"deadweight_tonnage,omitempty"`
// Draft Maximum draft (depth below waterline) of the vessel
Draft *int `json:"draft,omitempty"`
// DraftUnit Unit of measurement for draft (typically meters)
DraftUnit *string `json:"draft_unit,omitempty"`
// EngineModelName Model name of the main engine
EngineModelName *string `json:"engine_model_name,omitempty"`
// EngineType Type code for the main engine
EngineType *int `json:"engine_type,omitempty"`
// FormerNames List of previous names the vessel has operated under
FormerNames *[]GithubComVesselapiCommonVesselDataContractsTypesVesselFormerName `json:"former_names,omitempty"`
// GrossTonnage Gross tonnage (GT) - measure of vessel's overall internal volume
GrossTonnage *int `json:"gross_tonnage,omitempty"`
// HomePort Port of registry for the vessel
HomePort *string `json:"home_port,omitempty"`
// Imo IMO International Maritime Organization number - permanent 7-digit vessel identifier
Imo *int `json:"imo,omitempty"`
// KilowattPower Main engine power in kilowatts
KilowattPower *int `json:"kilowatt_power,omitempty"`
// Length Overall length of the vessel
Length *int `json:"length,omitempty"`
// LengthUnit Unit of measurement for length (typically meters)
LengthUnit *string `json:"length_unit,omitempty"`
// ManagerName Ship management company responsible for operations
ManagerName *string `json:"manager_name,omitempty"`
// Mmsi MMSI Maritime Mobile Service Identity - 9-digit radio identifier
Mmsi *int `json:"mmsi,omitempty"`
// Name The vessel's current registered name
Name *string `json:"name,omitempty"`
// OperatingStatus Current operational status (e.g., Active, Laid Up, Scrapped)
OperatingStatus *string `json:"operating_status,omitempty"`
// OwnerName Registered owner of the vessel
OwnerName *string `json:"owner_name,omitempty"`
// VesselType Classification of vessel type (e.g., Container Ship, Bulk Carrier)
VesselType *string `json:"vessel_type,omitempty"`
// YearBuilt Year the vessel was constructed
YearBuilt *int `json:"year_built,omitempty"`
}
Vessel Complete vessel static data including identification, dimensions, and ownership
type VesselClient ¶
type VesselClient struct {
// Vessels provides access to vessel-related endpoints.
Vessels *VesselsService
// Ports provides access to port lookup endpoints.
Ports *PortsService
// PortEvents provides access to port event endpoints.
PortEvents *PortEventsService
// Emissions provides access to emissions endpoints.
Emissions *EmissionsService
// Search provides access to search endpoints.
Search *SearchService
// Location provides access to location-based endpoints.
Location *LocationService
Navtex *NavtexService
// contains filtered or unexported fields
}
VesselClient is the high-level wrapper around the generated API client. It provides resource-oriented service accessors for interacting with the Vessel Tracking API.
func NewVesselClient ¶
func NewVesselClient(apiKey string, opts ...VesselClientOption) (*VesselClient, error)
NewVesselClient creates a new high-level Vessel API client. The apiKey is used as a Bearer token for authentication.
type VesselClientOption ¶
type VesselClientOption func(*clientConfig)
VesselClientOption configures a VesselClient.
func WithVesselBaseURL ¶
func WithVesselBaseURL(url string) VesselClientOption
WithVesselBaseURL sets the API base URL. Defaults to DefaultBaseURL.
func WithVesselHTTPClient ¶
func WithVesselHTTPClient(hc *http.Client) VesselClientOption
WithVesselHTTPClient sets the underlying HTTP client used for transport. The client's Transport is used as the base round-tripper; auth and retry transports are layered on top.
func WithVesselRetry ¶
func WithVesselRetry(maxRetries int) VesselClientOption
WithVesselRetry sets the maximum number of retries on 429 and 5xx responses. Defaults to 3.
func WithVesselUserAgent ¶
func WithVesselUserAgent(ua string) VesselClientOption
WithVesselUserAgent sets the User-Agent header value.
type VesselETA ¶
type VesselETA struct {
// Destination Reported destination port or area as entered by the vessel
Destination *string `json:"destination,omitempty"`
// Draught Current draught (draft) of the vessel in meters
Draught *float32 `json:"draught,omitempty"`
// Eta ETA Estimated time of arrival at destination as reported by the vessel
Eta *string `json:"eta,omitempty"`
// Imo IMO International Maritime Organization number - permanent vessel identifier
Imo *int `json:"imo,omitempty"`
// Mmsi MMSI Maritime Mobile Service Identity - unique 9-digit vessel identifier
Mmsi *int `json:"mmsi,omitempty"`
// Timestamp UTC timestamp when this ETA information was received
Timestamp *string `json:"timestamp,omitempty"`
// VesselName The vessel's registered name as reported in AIS
VesselName *string `json:"vessel_name,omitempty"`
}
VesselETA Vessel Estimated Time of Arrival information from AIS static/voyage data
type VesselETAResponse ¶
type VesselETAResponse struct {
// VesselEta Vessel Estimated Time of Arrival information from AIS static/voyage data
VesselEta *VesselETA `json:"vesselEta,omitempty"`
}
VesselETAResponse Response containing vessel ETA data
type VesselEmission ¶
type VesselEmission struct {
// Co2EmissionsAtBerth CO2 emitted while at berth in metric tonnes
Co2EmissionsAtBerth *float32 `json:"co2_emissions_at_berth,omitempty"`
// Co2EmissionsOnLadenVoyages CO2 emitted during laden voyages in metric tonnes
Co2EmissionsOnLadenVoyages *float32 `json:"co2_emissions_on_laden_voyages,omitempty"`
// Co2EmissionsTotal CO2 emissions
Co2EmissionsTotal *float32 `json:"co2_emissions_total,omitempty"`
// Co2PerDistance kg CO₂ / n mile
Co2PerDistance *float32 `json:"co2_per_distance,omitempty"`
// Co2PerTransportWork g CO₂ / m tonnes · n miles
Co2PerTransportWork *float32 `json:"co2_per_transport_work,omitempty"`
// CollectedAt UTC timestamp when data was collected
CollectedAt *string `json:"collected_at,omitempty"`
// DistanceThroughIce nautical miles
DistanceThroughIce *float32 `json:"distance_through_ice,omitempty"`
// DocExpiryDate Document of Compliance expiry date
DocExpiryDate *string `json:"doc_expiry_date,omitempty"`
// DocIssueDate DOC info
DocIssueDate *string `json:"doc_issue_date,omitempty"`
// FlagCode ISO country code of the flag state
FlagCode *string `json:"flag_code,omitempty"`
// FlagName Full name of the flag state
FlagName *string `json:"flag_name,omitempty"`
// FuelConsumptionHfo Heavy Fuel Oil consumption in metric tonnes
FuelConsumptionHfo *float32 `json:"fuel_consumption_hfo,omitempty"`
// FuelConsumptionLfo Light Fuel Oil consumption in metric tonnes
FuelConsumptionLfo *float32 `json:"fuel_consumption_lfo,omitempty"`
// FuelConsumptionLng Liquefied Natural Gas consumption in metric tonnes
FuelConsumptionLng *float32 `json:"fuel_consumption_lng,omitempty"`
// FuelConsumptionMdo Marine Diesel Oil consumption in metric tonnes
FuelConsumptionMdo *float32 `json:"fuel_consumption_mdo,omitempty"`
// FuelConsumptionMgo Marine Gas Oil consumption in metric tonnes
FuelConsumptionMgo *float32 `json:"fuel_consumption_mgo,omitempty"`
// FuelConsumptionOther Other fuel types consumption in metric tonnes
FuelConsumptionOther *float32 `json:"fuel_consumption_other,omitempty"`
// FuelConsumptionTotal Fuel consumption (tonnes)
FuelConsumptionTotal *float32 `json:"fuel_consumption_total,omitempty"`
// FuelPerDistance Efficiency metrics (pre-calculated)
FuelPerDistance *float32 `json:"fuel_per_distance,omitempty"`
// FuelPerTransportWork g / m tonnes · n miles
FuelPerTransportWork *float32 `json:"fuel_per_transport_work,omitempty"`
// HomePort Port of registry
HomePort *string `json:"home_port,omitempty"`
// IceClass Ice class designation
IceClass *string `json:"ice_class,omitempty"`
// Imo Identifiers
Imo *int `json:"imo,omitempty"`
// MonitoringMethodA Monitoring method
MonitoringMethodA *string `json:"monitoring_method_a,omitempty"`
// MonitoringMethodB Monitoring method B description
MonitoringMethodB *string `json:"monitoring_method_b,omitempty"`
// MonitoringMethodC Monitoring method C description
MonitoringMethodC *string `json:"monitoring_method_c,omitempty"`
// MonitoringMethodD Monitoring method D description
MonitoringMethodD *string `json:"monitoring_method_d,omitempty"`
// Name Vessel name
Name *string `json:"name,omitempty"`
// PortCallsOutsideEu Number of port calls outside the EU
PortCallsOutsideEu *int `json:"port_calls_outside_eu,omitempty"`
// PortCallsWithinEu EU specific
PortCallsWithinEu *int `json:"port_calls_within_eu,omitempty"`
// ReportingPeriod Reporting period
ReportingPeriod *string `json:"reporting_period,omitempty"`
// SourceUrl Metadata
SourceUrl *string `json:"source_url,omitempty"`
// TechnicalEfficiency Technical efficiency
TechnicalEfficiency *string `json:"technical_efficiency,omitempty"`
// TechnicalEfficiencyValue Numeric value of the technical efficiency metric
TechnicalEfficiencyValue *float32 `json:"technical_efficiency_value,omitempty"`
// TimeAtSeaThroughIce hours
TimeAtSeaThroughIce *float32 `json:"time_at_sea_through_ice,omitempty"`
// TotalTimeAtSea Distance and time
TotalTimeAtSea *float32 `json:"total_time_at_sea,omitempty"`
// UniqueKey Unique key for upsert (imo_period)
UniqueKey *string `json:"unique_key,omitempty"`
// VerifierAccreditation Accreditation details of the verifier
VerifierAccreditation *string `json:"verifier_accreditation,omitempty"`
// VerifierAddress Address of the verification body
VerifierAddress *string `json:"verifier_address,omitempty"`
// VerifierName Verifier info
VerifierName *string `json:"verifier_name,omitempty"`
// VesselType Vessel identification
VesselType *string `json:"vessel_type,omitempty"`
}
VesselEmission EU MRV vessel emissions report including CO2 emissions, fuel consumption, and efficiency metrics
type VesselEmissionsResponse ¶
type VesselEmissionsResponse struct {
// Emissions List of vessel emission records
Emissions *[]VesselEmission `json:"emissions,omitempty"`
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
}
VesselEmissionsResponse Response containing vessel emissions data
type VesselPosition ¶
type VesselPosition struct {
// Cog COG Course Over Ground in degrees (0-359.9), null when unavailable
Cog *float32 `json:"cog,omitempty"`
// Heading True heading in degrees (0-359), null when unavailable
Heading *int `json:"heading,omitempty"`
// Imo IMO International Maritime Organization number - permanent vessel identifier
Imo *int `json:"imo,omitempty"`
// Latitude Geographic latitude in decimal degrees (-90 to 90)
Latitude *float64 `json:"latitude,omitempty"`
// Location GeoJSON point for geospatial queries
Location *GithubComVesselapiCommonVesselDataContractsTypesGeoJSON `json:"location,omitempty"`
// Longitude Geographic longitude in decimal degrees (-180 to 180)
Longitude *float64 `json:"longitude,omitempty"`
// Mmsi MMSI Maritime Mobile Service Identity - unique 9-digit vessel identifier
Mmsi *int `json:"mmsi,omitempty"`
NavStatus *int `json:"nav_status,omitempty"`
// ProcessedTimestamp UTC timestamp when the position was processed by the system
ProcessedTimestamp *string `json:"processed_timestamp,omitempty"`
// Sog SOG Speed Over Ground in knots (0-102.2), null when unavailable
Sog *float32 `json:"sog,omitempty"`
// SuspectedGlitch indicates the position may be unreliable due to a GPS glitch or corrupted AIS transmission (implies impossible vessel speed)
SuspectedGlitch *bool `json:"suspected_glitch,omitempty"`
// Timestamp UTC timestamp when the AIS message was transmitted by the vessel
Timestamp *string `json:"timestamp,omitempty"`
// VesselName The vessel's registered name as reported in AIS
VesselName *string `json:"vessel_name,omitempty"`
}
VesselPosition Real-time vessel position data derived from AIS messages
type VesselPositionResponse ¶
type VesselPositionResponse struct {
// VesselPosition Real-time vessel position data derived from AIS messages
VesselPosition *VesselPosition `json:"vesselPosition,omitempty"`
}
VesselPositionResponse Response containing a single vessel position
type VesselPositionsResponse ¶
type VesselPositionsResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// VesselPositions List of vessel position records
VesselPositions *[]VesselPosition `json:"vesselPositions,omitempty"`
}
VesselPositionsResponse Response containing vessel position data
type VesselResponse ¶
type VesselResponse struct {
// Vessel Complete vessel static data including identification, dimensions, and ownership
Vessel *Vessel `json:"vessel,omitempty"`
}
VesselResponse Response containing vessel data
type VesselsService ¶
type VesselsService struct {
// contains filtered or unexported fields
}
VesselsService wraps vessel-related API endpoints.
func (*VesselsService) AllCasualties ¶
func (s *VesselsService) AllCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams) *Iterator[MarineCasualty]
AllCasualties returns an iterator over all casualties for a vessel.
func (*VesselsService) AllEmissions ¶
func (s *VesselsService) AllEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams) *Iterator[VesselEmission]
AllEmissions returns an iterator over all emissions for a vessel.
func (*VesselsService) AllPositions ¶
func (s *VesselsService) AllPositions(ctx context.Context, params *GetVesselsPositionsParams) *Iterator[VesselPosition]
AllPositions returns an iterator over all positions for multiple vessels.
func (*VesselsService) Casualties ¶
func (s *VesselsService) Casualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams) (*MarineCasualtiesResponse, error)
Casualties retrieves marine casualty records for a vessel.
func (*VesselsService) Classification ¶
func (s *VesselsService) Classification(ctx context.Context, id string, params *GetVesselIdClassificationParams) (*ClassificationResponse, error)
Classification retrieves classification data for a vessel.
func (*VesselsService) ETA ¶
func (s *VesselsService) ETA(ctx context.Context, id string, params *GetVesselIdEtaParams) (*VesselETAResponse, error)
ETA retrieves the estimated time of arrival for a vessel.
func (*VesselsService) Emissions ¶
func (s *VesselsService) Emissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams) (*VesselEmissionsResponse, error)
Emissions retrieves emissions data for a vessel.
func (*VesselsService) Get ¶
func (s *VesselsService) Get(ctx context.Context, id string, params *GetVesselIdParams) (*VesselResponse, error)
Get retrieves vessel details by ID (IMO or MMSI).
func (*VesselsService) InspectionDetail ¶
func (s *VesselsService) InspectionDetail(ctx context.Context, id, detailId string, params *GetVesselIdInspectionsDetailIdParams) (*TypesInspectionDetailResponse, error)
InspectionDetail retrieves detailed inspection data.
func (*VesselsService) Inspections ¶
func (s *VesselsService) Inspections(ctx context.Context, id string, params *GetVesselIdInspectionsParams) (*TypesInspectionsResponse, error)
Inspections retrieves inspection records for a vessel.
func (*VesselsService) Ownership ¶
func (s *VesselsService) Ownership(ctx context.Context, id string, params *GetVesselIdOwnershipParams) (*TypesOwnershipResponse, error)
Ownership retrieves ownership data for a vessel.
func (*VesselsService) Position ¶
func (s *VesselsService) Position(ctx context.Context, id string, params *GetVesselIdPositionParams) (*VesselPositionResponse, error)
Position retrieves the latest position for a vessel.
func (*VesselsService) Positions ¶
func (s *VesselsService) Positions(ctx context.Context, params *GetVesselsPositionsParams) (*VesselPositionsResponse, error)
Positions retrieves positions for multiple vessels.
type VesselsWithinLocationResponse ¶
type VesselsWithinLocationResponse struct {
// NextToken Opaque token for fetching the next page, or null if no more results
NextToken *string `json:"nextToken,omitempty"`
// Vessels List of vessel positions within the specified area
Vessels *[]VesselPosition `json:"vessels,omitempty"`
}
VesselsWithinLocationResponse Response containing vessel within location data