Overview

Summary

ContactDonateImprint


2. Modular API



2.1 Module System




2.2 Module Interfaces


API 1: ApiClientService-API (18)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /vesseltechnicaldetailinsertVesselTechnicalDetail(vesseltechnicaldetail)ApiClientModulePOSTVesselTechnicalDetail
(2) /apiclient/{id}findApiClientById(id)ApiClientModuleGETApiClient
(3) /vesseltechnicaldetailfindAllVesselTechnicalDetail()ApiClientModuleGETVesselTechnicalDetail
(4) /apiusagelog/{id}deleteApiUsageLogById(id)ApiClientModuleDELETEApiUsageLog
(5) /vesseltechnicaldetail/{id}deleteVesselTechnicalDetailById(id)ApiClientModuleDELETEVesselTechnicalDetail
(6) /apiusageloginsertApiUsageLog(apiusagelog)ApiClientModulePOSTApiUsageLog
(7) /apiusagelog/{id}findApiUsageLogById(id)ApiClientModuleGETApiUsageLog
(8) /apiclientinsertApiClient(apiclient)ApiClientModulePOSTApiClient
(9) /apiclient/{id}updateApiClientById(apiclient)ApiClientModulePUTApiClient
(10) /apiusagelog/{id}updateApiUsageLogById(apiusagelog)ApiClientModulePUTApiUsageLog
(11) /apiusagelog/apiclient/{id}findAllApiUsageLogOfApiClient(id)ApiClientModuleGETApiClient ApiUsageLog
(12) /apiusagelogfindAllApiUsageLog()ApiClientModuleGETApiUsageLog
(13) /apiclient/{id}deleteApiClientById(id)ApiClientModuleDELETEApiClient
(14) /apiclient/useraccount/{id}findAllApiClientOfUserAccount(id)ApiClientModuleGETUserAccount ApiClient
(15) /vesseltechnicaldetail/{id}findVesselTechnicalDetailById(id)ApiClientModuleGETVesselTechnicalDetail
(16) /apiclientfindAllApiClient()ApiClientModuleGETApiClient
(17) /vesseltechnicaldetail/vessel/{id}findAllVesselTechnicalDetailOfVessel(id)ApiClientModuleGETVessel VesselTechnicalDetail
(18) /vesseltechnicaldetail/{id}updateVesselTechnicalDetailById(vesseltechnicaldetail)ApiClientModulePUTVesselTechnicalDetail

API 2: FleetService-API (27)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /vesselidentifierhistory/previousflagcountry/{id}findAllVesselIdentifierHistoryOfPreviousFlagCountry(id)FleetModuleGETCountry VesselIdentifierHistory
(2) /notificationfindAllNotification()FleetModuleGETNotification
(3) /fleetvessel/vessel/{id}findAllFleetVesselOfVessel(id)FleetModuleGETVessel FleetVessel
(4) /fleetvessel/fleet/{id}findAllFleetVesselOfFleet(id)FleetModuleGETFleet FleetVessel
(5) /vesselidentifierhistory/{id}findVesselIdentifierHistoryById(id)FleetModuleGETVesselIdentifierHistory
(6) /fleetvesselinsertFleetVessel(fleetvessel)FleetModulePOSTFleetVessel
(7) /notification/{id}findNotificationById(id)FleetModuleGETNotification
(8) /vesselidentifierhistoryfindAllVesselIdentifierHistory()FleetModuleGETVesselIdentifierHistory
(9) /fleet/{id}updateFleetById(fleet)FleetModulePUTFleet
(10) /notificationinsertNotification(notification)FleetModulePOSTNotification
(11) /notification/{id}deleteNotificationById(id)FleetModuleDELETENotification
(12) /fleet/owneruser/{id}findAllFleetOfOwnerUser(id)FleetModuleGETUserAccount Fleet
(13) /fleetinsertFleet(fleet)FleetModulePOSTFleet
(14) /fleet/{id}deleteFleetById(id)FleetModuleDELETEFleet
(15) /fleetvesselfindAllFleetVessel()FleetModuleGETFleetVessel
(16) /fleet/{id}findFleetById(id)FleetModuleGETFleet
(17) /vesselidentifierhistory/{id}updateVesselIdentifierHistoryById(vesselidentifierhistory)FleetModulePUTVesselIdentifierHistory
(18) /fleetfindAllFleet()FleetModuleGETFleet
(19) /vesselidentifierhistory/{id}deleteVesselIdentifierHistoryById(id)FleetModuleDELETEVesselIdentifierHistory
(20) /vesselidentifierhistory/vessel/{id}findAllVesselIdentifierHistoryOfVessel(id)FleetModuleGETVessel VesselIdentifierHistory
(21) /notification/useraccount/{id}findAllNotificationOfUserAccount(id)FleetModuleGETUserAccount Notification
(22) /fleetvessel/{id}findFleetVesselById(id)FleetModuleGETFleetVessel
(23) /fleetvessel/{id}deleteFleetVesselById(id)FleetModuleDELETEFleetVessel
(24) /fleetvessel/{id}updateFleetVesselById(fleetvessel)FleetModulePUTFleetVessel
(25) /notification/alertevent/{id}findAllNotificationOfAlertEvent(id)FleetModuleGETAlertEvent Notification
(26) /vesselidentifierhistoryinsertVesselIdentifierHistory(vesselidentifierhistory)FleetModulePOSTVesselIdentifierHistory
(27) /notification/{id}updateNotificationById(notification)FleetModulePUTNotification

API 3: GeographicalAreaService-API (23)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /geographicalareainsertGeographicalArea(geographicalarea)GeographicalAreaModulePOSTGeographicalArea
(2) /geographicalareafindAllGeographicalArea()GeographicalAreaModuleGETGeographicalArea
(3) /aismessage/aisstation/{id}findAllAisMessageOfAisStation(id)GeographicalAreaModuleGETAisStation AisMessage
(4) /aisstationfindAllAisStation()GeographicalAreaModuleGETAisStation
(5) /aismessage/{id}updateAisMessageById(aismessage)GeographicalAreaModulePUTAisMessage
(6) /geographicalarea/{id}findGeographicalAreaById(id)GeographicalAreaModuleGETGeographicalArea
(7) /vesselstatus/{id}deleteVesselStatusById(id)GeographicalAreaModuleDELETEVesselStatus
(8) /vesselstatus/{id}updateVesselStatusById(vesselstatus)GeographicalAreaModulePUTVesselStatus
(9) /aismessage/{id}findAisMessageById(id)GeographicalAreaModuleGETAisMessage
(10) /aismessage/{id}deleteAisMessageById(id)GeographicalAreaModuleDELETEAisMessage
(11) /vesselstatusinsertVesselStatus(vesselstatus)GeographicalAreaModulePOSTVesselStatus
(12) /aismessageinsertAisMessage(aismessage)GeographicalAreaModulePOSTAisMessage
(13) /geographicalarea/{id}deleteGeographicalAreaById(id)GeographicalAreaModuleDELETEGeographicalArea
(14) /geographicalarea/{id}updateGeographicalAreaById(geographicalarea)GeographicalAreaModulePUTGeographicalArea
(15) /vesselstatusfindAllVesselStatus()GeographicalAreaModuleGETVesselStatus
(16) /aisstation/{id}deleteAisStationById(id)GeographicalAreaModuleDELETEAisStation
(17) /aisstation/country/{id}findAllAisStationOfCountry(id)GeographicalAreaModuleGETCountry AisStation
(18) /aisstationinsertAisStation(aisstation)GeographicalAreaModulePOSTAisStation
(19) /aismessagefindAllAisMessage()GeographicalAreaModuleGETAisMessage
(20) /aisstation/{id}updateAisStationById(aisstation)GeographicalAreaModulePUTAisStation
(21) /aisstation/{id}findAisStationById(id)GeographicalAreaModuleGETAisStation
(22) /aismessage/vessel/{id}findAllAisMessageOfVessel(id)GeographicalAreaModuleGETVessel AisMessage
(23) /vesselstatus/{id}findVesselStatusById(id)GeographicalAreaModuleGETVesselStatus

API 4: PhotoService-API (20)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /photo/useraccount/{id}findAllPhotoOfUserAccount(id)PhotoModuleGETUserAccount Photo
(2) /photoratingfindAllPhotoRating()PhotoModuleGETPhotoRating
(3) /photoratinginsertPhotoRating(photorating)PhotoModulePOSTPhotoRating
(4) /photo/{id}findPhotoById(id)PhotoModuleGETPhoto
(5) /userdeviceinsertUserDevice(userdevice)PhotoModulePOSTUserDevice
(6) /photorating/useraccount/{id}findAllPhotoRatingOfUserAccount(id)PhotoModuleGETUserAccount PhotoRating
(7) /photo/{id}deletePhotoById(id)PhotoModuleDELETEPhoto
(8) /photo/{id}updatePhotoById(photo)PhotoModulePUTPhoto
(9) /photorating/photo/{id}findAllPhotoRatingOfPhoto(id)PhotoModuleGETPhoto PhotoRating
(10) /userdevicefindAllUserDevice()PhotoModuleGETUserDevice
(11) /photorating/{id}findPhotoRatingById(id)PhotoModuleGETPhotoRating
(12) /userdevice/useraccount/{id}findAllUserDeviceOfUserAccount(id)PhotoModuleGETUserAccount UserDevice
(13) /photo/vessel/{id}findAllPhotoOfVessel(id)PhotoModuleGETVessel Photo
(14) /photorating/{id}updatePhotoRatingById(photorating)PhotoModulePUTPhotoRating
(15) /photofindAllPhoto()PhotoModuleGETPhoto
(16) /photorating/{id}deletePhotoRatingById(id)PhotoModuleDELETEPhotoRating
(17) /photoinsertPhoto(photo)PhotoModulePOSTPhoto
(18) /userdevice/{id}updateUserDeviceById(userdevice)PhotoModulePUTUserDevice
(19) /userdevice/{id}deleteUserDeviceById(id)PhotoModuleDELETEUserDevice
(20) /userdevice/{id}findUserDeviceById(id)PhotoModuleGETUserDevice

API 5: PortService-API (33)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /routeinsertRoute(route)PortModulePOSTRoute
(2) /alertevent/positionreport/{id}findAllAlertEventOfPositionReport(id)PortModuleGETPositionReport AlertEvent
(3) /port/{id}findPortById(id)PortModuleGETPort
(4) /port/country/{id}findAllPortOfCountry(id)PortModuleGETCountry Port
(5) /alertrule/useraccount/{id}findAllAlertRuleOfUserAccount(id)PortModuleGETUserAccount AlertRule
(6) /alerteventinsertAlertEvent(alertevent)PortModulePOSTAlertEvent
(7) /route/{id}updateRouteById(route)PortModulePUTRoute
(8) /port/{id}deletePortById(id)PortModuleDELETEPort
(9) /alertevent/{id}findAlertEventById(id)PortModuleGETAlertEvent
(10) /alerteventfindAllAlertEvent()PortModuleGETAlertEvent
(11) /route/{id}findRouteById(id)PortModuleGETRoute
(12) /alertrule/vessel/{id}findAllAlertRuleOfVessel(id)PortModuleGETVessel AlertRule
(13) /alertevent/port/{id}findAllAlertEventOfPort(id)PortModuleGETPort AlertEvent
(14) /route/endport/{id}findAllRouteOfEndPort(id)PortModuleGETPort Route
(15) /alertrule/{id}deleteAlertRuleById(id)PortModuleDELETEAlertRule
(16) /alertrule/geographicalarea/{id}findAllAlertRuleOfGeographicalArea(id)PortModuleGETGeographicalArea AlertRule
(17) /alertrule/{id}updateAlertRuleById(alertrule)PortModulePUTAlertRule
(18) /alertruleinsertAlertRule(alertrule)PortModulePOSTAlertRule
(19) /alertevent/{id}deleteAlertEventById(id)PortModuleDELETEAlertEvent
(20) /alertrule/port/{id}findAllAlertRuleOfPort(id)PortModuleGETPort AlertRule
(21) /route/startport/{id}findAllRouteOfStartPort(id)PortModuleGETPort Route
(22) /route/vessel/{id}findAllRouteOfVessel(id)PortModuleGETVessel Route
(23) /alertrulefindAllAlertRule()PortModuleGETAlertRule
(24) /portinsertPort(port)PortModulePOSTPort
(25) /alertevent/{id}updateAlertEventById(alertevent)PortModulePUTAlertEvent
(26) /alertevent/alertrule/{id}findAllAlertEventOfAlertRule(id)PortModuleGETAlertRule AlertEvent
(27) /routefindAllRoute()PortModuleGETRoute
(28) /alertrule/{id}findAlertRuleById(id)PortModuleGETAlertRule
(29) /alertevent/vessel/{id}findAllAlertEventOfVessel(id)PortModuleGETVessel AlertEvent
(30) /portfindAllPort()PortModuleGETPort
(31) /alertevent/geographicalarea/{id}findAllAlertEventOfGeographicalArea(id)PortModuleGETGeographicalArea AlertEvent
(32) /route/{id}deleteRouteById(id)PortModuleDELETERoute
(33) /port/{id}updatePortById(port)PortModulePUTPort

API 6: SubscriptionPlanService-API (26)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /portcall/{id}updatePortCallById(portcall)SubscriptionPlanModulePUTPortCall
(2) /portcall/vessel/{id}findAllPortCallOfVessel(id)SubscriptionPlanModuleGETVessel PortCall
(3) /portcall/{id}deletePortCallById(id)SubscriptionPlanModuleDELETEPortCall
(4) /subscriptionplan/{id}deleteSubscriptionPlanById(id)SubscriptionPlanModuleDELETESubscriptionPlan
(5) /portcallinsertPortCall(portcall)SubscriptionPlanModulePOSTPortCall
(6) /subscriptionplan/{id}updateSubscriptionPlanById(subscriptionplan)SubscriptionPlanModulePUTSubscriptionPlan
(7) /portcallfindAllPortCall()SubscriptionPlanModuleGETPortCall
(8) /portcall/port/{id}findAllPortCallOfPort(id)SubscriptionPlanModuleGETPort PortCall
(9) /portcall/route/{id}findAllPortCallOfRoute(id)SubscriptionPlanModuleGETRoute PortCall
(10) /usersubscriptioninsertUserSubscription(usersubscription)SubscriptionPlanModulePOSTUserSubscription
(11) /subscriptionplan/{id}findSubscriptionPlanById(id)SubscriptionPlanModuleGETSubscriptionPlan
(12) /routewaypoint/{id}deleteRouteWaypointById(id)SubscriptionPlanModuleDELETERouteWaypoint
(13) /routewaypoint/{id}findRouteWaypointById(id)SubscriptionPlanModuleGETRouteWaypoint
(14) /usersubscription/{id}findUserSubscriptionById(id)SubscriptionPlanModuleGETUserSubscription
(15) /routewaypoint/route/{id}findAllRouteWaypointOfRoute(id)SubscriptionPlanModuleGETRoute RouteWaypoint
(16) /usersubscriptionfindAllUserSubscription()SubscriptionPlanModuleGETUserSubscription
(17) /subscriptionplanfindAllSubscriptionPlan()SubscriptionPlanModuleGETSubscriptionPlan
(18) /subscriptionplaninsertSubscriptionPlan(subscriptionplan)SubscriptionPlanModulePOSTSubscriptionPlan
(19) /routewaypointinsertRouteWaypoint(routewaypoint)SubscriptionPlanModulePOSTRouteWaypoint
(20) /portcall/{id}findPortCallById(id)SubscriptionPlanModuleGETPortCall
(21) /usersubscription/subscriptionplan/{id}findAllUserSubscriptionOfSubscriptionPlan(id)SubscriptionPlanModuleGETSubscriptionPlan UserSubscription
(22) /usersubscription/useraccount/{id}findAllUserSubscriptionOfUserAccount(id)SubscriptionPlanModuleGETUserAccount UserSubscription
(23) /usersubscription/{id}deleteUserSubscriptionById(id)SubscriptionPlanModuleDELETEUserSubscription
(24) /routewaypointfindAllRouteWaypoint()SubscriptionPlanModuleGETRouteWaypoint
(25) /routewaypoint/{id}updateRouteWaypointById(routewaypoint)SubscriptionPlanModulePUTRouteWaypoint
(26) /usersubscription/{id}updateUserSubscriptionById(usersubscription)SubscriptionPlanModulePUTUserSubscription

API 7: UserAccountService-API (24)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /savedfilter/{id}deleteSavedFilterById(id)UserAccountModuleDELETESavedFilter
(2) /vesselcommentfindAllVesselComment()UserAccountModuleGETVesselComment
(3) /savedfilter/{id}findSavedFilterById(id)UserAccountModuleGETSavedFilter
(4) /useraccountinsertUserAccount(useraccount)UserAccountModulePOSTUserAccount
(5) /savedfilterinsertSavedFilter(savedfilter)UserAccountModulePOSTSavedFilter
(6) /countryfindAllCountry()UserAccountModuleGETCountry
(7) /countryinsertCountry(country)UserAccountModulePOSTCountry
(8) /vesselcomment/{id}findVesselCommentById(id)UserAccountModuleGETVesselComment
(9) /useraccount/country/{id}findAllUserAccountOfCountry(id)UserAccountModuleGETCountry UserAccount
(10) /vesselcomment/vessel/{id}findAllVesselCommentOfVessel(id)UserAccountModuleGETVessel VesselComment
(11) /useraccount/{id}updateUserAccountById(useraccount)UserAccountModulePUTUserAccount
(12) /useraccount/{id}findUserAccountById(id)UserAccountModuleGETUserAccount
(13) /vesselcomment/useraccount/{id}findAllVesselCommentOfUserAccount(id)UserAccountModuleGETUserAccount VesselComment
(14) /vesselcomment/{id}deleteVesselCommentById(id)UserAccountModuleDELETEVesselComment
(15) /useraccount/{id}deleteUserAccountById(id)UserAccountModuleDELETEUserAccount
(16) /useraccountfindAllUserAccount()UserAccountModuleGETUserAccount
(17) /vesselcommentinsertVesselComment(vesselcomment)UserAccountModulePOSTVesselComment
(18) /country/{id}deleteCountryById(id)UserAccountModuleDELETECountry
(19) /savedfilter/useraccount/{id}findAllSavedFilterOfUserAccount(id)UserAccountModuleGETUserAccount SavedFilter
(20) /country/{id}findCountryById(id)UserAccountModuleGETCountry
(21) /savedfilter/{id}updateSavedFilterById(savedfilter)UserAccountModulePUTSavedFilter
(22) /savedfilterfindAllSavedFilter()UserAccountModuleGETSavedFilter
(23) /vesselcomment/{id}updateVesselCommentById(vesselcomment)UserAccountModulePUTVesselComment
(24) /country/{id}updateCountryById(country)UserAccountModulePUTCountry

API 8: VesselService-API (27)

Remote MethodLocal MethodModuleHTTP-MethodReferences
(1) /vesseltypefindAllVesselType()VesselModuleGETVesselType
(2) /positionreport/{id}findPositionReportById(id)VesselModuleGETPositionReport
(3) /vesseltype/{id}updateVesselTypeById(vesseltype)VesselModulePUTVesselType
(4) /vesselfindAllVessel()VesselModuleGETVessel
(5) /vesseldailysummaryinsertVesselDailySummary(vesseldailysummary)VesselModulePOSTVesselDailySummary
(6) /positionreport/vessel/{id}findAllPositionReportOfVessel(id)VesselModuleGETVessel PositionReport
(7) /vessel/vesselstatus/{id}findAllVesselOfVesselStatus(id)VesselModuleGETVesselStatus Vessel
(8) /positionreport/{id}deletePositionReportById(id)VesselModuleDELETEPositionReport
(9) /vesselinsertVessel(vessel)VesselModulePOSTVessel
(10) /vessel/{id}updateVesselById(vessel)VesselModulePUTVessel
(11) /vessel/flagcountry/{id}findAllVesselOfFlagCountry(id)VesselModuleGETCountry Vessel
(12) /positionreport/geographicalarea/{id}findAllPositionReportOfGeographicalArea(id)VesselModuleGETGeographicalArea PositionReport
(13) /positionreport/{id}updatePositionReportById(positionreport)VesselModulePUTPositionReport
(14) /vesseltype/{id}findVesselTypeById(id)VesselModuleGETVesselType
(15) /positionreportfindAllPositionReport()VesselModuleGETPositionReport
(16) /positionreportinsertPositionReport(positionreport)VesselModulePOSTPositionReport
(17) /vessel/{id}findVesselById(id)VesselModuleGETVessel
(18) /vesseldailysummaryfindAllVesselDailySummary()VesselModuleGETVesselDailySummary
(19) /vessel/{id}deleteVesselById(id)VesselModuleDELETEVessel
(20) /vesseldailysummary/{id}deleteVesselDailySummaryById(id)VesselModuleDELETEVesselDailySummary
(21) /vesseldailysummary/vessel/{id}findAllVesselDailySummaryOfVessel(id)VesselModuleGETVessel VesselDailySummary
(22) /positionreport/aisstation/{id}findAllPositionReportOfAisStation(id)VesselModuleGETAisStation PositionReport
(23) /vesseltypeinsertVesselType(vesseltype)VesselModulePOSTVesselType
(24) /vesseltype/{id}deleteVesselTypeById(id)VesselModuleDELETEVesselType
(25) /vessel/vesseltype/{id}findAllVesselOfVesselType(id)VesselModuleGETVesselType Vessel
(26) /vesseldailysummary/{id}findVesselDailySummaryById(id)VesselModuleGETVesselDailySummary
(27) /vesseldailysummary/{id}updateVesselDailySummaryById(vesseldailysummary)VesselModulePUTVesselDailySummary



Overview

Summary

ContactDonateImprint