- Legacy APIThe previous API version is available at this location:
.
- added Added new method
GET /api/Parts/GetDeletedParts to allow users to get deleted parts within a certain timeframe. Please note that parts deleted more than one year ago are hard deleted unless they are still linked to a non historic entity.
- changed For backwards compatibility considerations, providing the API Key in the
Query String Parameters will be further supported. It's recommended to use the more secure approach and provide the API Key in the Request Headers.
- changed The
PATCH /PNPurchase/UpdateOrderLines, PATCH /PNPurchase/UpdateRequisitionLabels, POST /PNPurchase/ImportRequisitions, and PATCH /PNPurchase/UpdatePurchaseOrders methods were modified to return HTTP status code 207 Multi-Status for partial success responses (when some operations succeed but others fail with warnings), 400 Bad Request when the operation fails completely due to errors and 200 OK when the request is successful.
- changed The
POST /api/LibraryComponentOperations/CopyComponentsToVessels method was modified to return also the vessel ID, distributed component ID and distributed component parent ID.
- changed The
GET /api/CrewingSchedule method was modified to return also the ID of each crewing schedule, increasing the compatibility with the new method PUT /api/CrewingSchedule.
- added Added new method
PUT /api/CrewingSchedule to allow users to update crew member schedules, excepting recurrences.
- added Added new method
POST /api/CrewingSchedule to allow users to add crew member schedules, excepting recurrences.
- changed The
GET /api/Crewing method was modified to allow users to filter crew members by the creation date and modified date.
- added Added new method
POST /api/CrewingDocuments/GetPassportDetails to retrieve passport details of multiple crew members. The POST method was used instead of the GET method because the GET method has a limitation of query parameters length.
- added Added new method
POST /api/CrewingDocuments/GetCrewMembersDocuments to retrieve documents of multiple crew members. The POST method was used instead of the GET method because the GET method has a limitation of query parameters length.
- changedExtended the
GET /api/PNPurchase/GetRequisitionDetails and GET /api/PNPurchase/GetNextRequisitionDetails with RequisitionItemNumber parameter in PriceQuotationLines
- added Added new method
POST /api/CrewingDocuments to allow users to add new crew member documents.
- added Added new method
DELETE /api/CrewingDocuments to allow users to delete crew member documents.
- added Added new method
GET /api/CrewingDocuments/DocumentGroupNames to retrieve list of document group names for the current company.
- added Added new method
GET /api/Crewing/CrewMember to retrieve a single crew member by ID.
- added Added new controller
Countries with method GET /api/Countries/GetCountries to retrieve all countries.
- added Added new controller
Nationality with method GET /api/Nationality/GetNationalities to retrieve all nationalities or filter by country. Returns nationality ID, name, and associated country details (ID, name, code), ordered by nationality name.
- added Added new method
GET /api/AddressBooks/GetCrewAgents to retrieve all crew agents from the company.
- changed The
GET /api/Certificates method was modified to allow searching by certificateID, if provided.
- changed The
GET /api/PNPurchase/GetRequisitionDetails and GET /api/PNPurchase/GetNextRequisitionDetails methods were modified to return the status names defined in Marad
-
changed
The following methods were marked as HighProcessing/Static data and will have a rate limiting policy of 1 request/minute:
GET api/AddressBooks/GetSuppliers
GET api/Crewing
GET api/CrewingSchedule
GET api/indicators
GET api/LibraryComponentOperations
GET api/LibraryComponentOperations
GET api/ranks/getranks
GET api/Synchronization/getSyncDetails
GET api/users/getusers
GET api/users/GetUsersWithRank/{rankName}
GET api/vessels/getVessels
The other methods are limited to 15 requests/minute.
- changed Generic API was updated to
.NET 8.
-
breaking
Generic API: In v5.5.23, the
API Key via Query String Parameters remains temporarily supported for backward compatibility. Starting with v5.5.24, this will be removed; the API Key must be provided exclusively in the request headers.
- added Implemented Group by Controller/Module dropdown; when the Module view is used,
/module/ is added in front of the method name (e.g., GET /module/PNPurchase/GetRequisitionDetails); in the Controller view, nothing changed.
- changed The
POST /api/LibraryComponentOperations/CopyComponentsToVessels method was modified to return also the vessel ID, distributed component ID and distributed component parent ID.
- changed Extended the
GET /PNPurchase/GetRequisitionDetails and GET /PNPurchase/GetNextRequisitionDetails with InvoiceTotal and InvoiceTotalCurrency parameters.
- changed The
PUT /api/JobOperations method was modified to not allow users to edit a historic/executed one-time task.
- changed The
PUT /api/JobOperations method was modified to not allow users to edit the JobType of executed Interval and Defect Report tasks.
- added Added new method
GET /api/Components/GetRunningHoursHistories to retrieve counter histories.
- changed Extended the
GET /PNPurchase/GetRequisitionDetails and GET /PNPurchase/GetNextRequisitionDetails with RequisitionCreationDate and OrderLineCreationDate parameters; in the PurchaseOrders section, the Date parameter was renamed to purchaseOrderCreationDate.
- changed The
GET /PNPurchase/GetRequisitionDetails and GET /PNPurchase/GetNextRequisitionDetails methods were changed to display the PO extension when the "Keep the same number" option is used.
- changed Extended the
GET /api/FinancialDimensions/Projects/GetProjects, GET /api/FinancialDimensions/Projects/GetVesselProjects, and GET /api/FinancialDimensions/Projects/GetProject with ExternalReferenceID parameter.
- changed The
GET /PNPurchase/UpdateOrderLines was modified to make the DeliveredQuantity field mandatory only when changing the status of an order line from the Vessel status. Also the field is now mandatory when changing the status of an order line from the Warehouse status only if the "Is 'Delivery quantity' mandatory in warehouse" setting is active.
- changed Updated the ISSA parameter to GTIN in
GET /PNPurchase/GetRequisitionDetails, GET /PNPurchase/GetNextRequisitionDetails, PATCH /PNPurchase/UpdateOrderLines and POST /PNPurchase/ImportRequisitions
- changed Updated the
POST /api/LibraryParts, PUT /api/LibraryParts, POST /api/Parts/ImportVesselParts, POST /api/Parts/ImportLibraryParts, POST /api/Parts/LinkLibraryParts, POST /api/Parts/UnlinkPartFromComponent to allow link/unlink a component to a part based on the ComponentName and ParentComponentName.
- changed Extended the returned data for
GET /PNPurchase/GetRequisitionDetails and GET /PNPurchase/GetNextRequisitionDetails that includes now the Approvals section for Purchase Order approvals.
- changed Extended the
GET /api/Users/GetUsers, GET /api/Users/GetUsersWithRank/{rankName}, GET /api/Users/GetUsersOnVessel/{vesselName}, GET /api/Users/GetUser/{userName}, POST /api/Users/Save with SSOIdentifier parameter.
- added Added a new method
GET /api/Reports/GetQHSEReports to retrieve QHSE reports on a vessel.
- changed Extended the
GET /PNPurchase/GetRequisitionDetails and GET /PNPurchase/GetNextRequisitionDetails with RequisitionCreationDate and OrderLineCreationDate parameter.
- changed Renamed the
Date parameter in GET /PNPurchase/GetRequisitionDetails and GET /PNPurchase/GetNextRequisitionDetails to PurchaseOrderCreationDate parameter.
- added Added a new method
GET /api/CrewingRestHours to retrieve crew members' rest hours.
- added Added a new method
GET /api/Voyages/GetVoyages to retrieve all voyages from a vessel within a specified interval.
- changed Updated the
GET /api/Parts/GetPartsHistory that can receive now the optional startDate and endDate parameters.
- changed Extended the returned data for
Purchase Orders that includes now a boolean field AtExternalWarehouse.
- changed Extended the returned data for
Price Quotation Freight Costs that includes now the VatPrice.
- changed Extended the returned data for
GET /api/Parts/GetPartsPerVessel that includes now the IsLibraryPart for library distributed parts.
- changed Updated the
GET /api/Parts/ImportVesselParts to allow editing data for library distributed parts.