Breadcrumbs

API - Vessels

Overview

The list of Vessels.

Endpoint name

vessels

Source table

WiFi Vessel

Fixed view


Requests allowed

GET, POST, PATCH, DELETE

Primary key

code

Record ID

code

Procedures



Data

Field List

Property

Type

Format

Description


code

string


Code

Record ID

primary key

systemId

string

uuid

SystemId

non-editable

name

string


Name

optional

callSign

string


Call Sign

optional

address

string


Address

optional

countryOfOrigin

string


Country of Origin

optional

gln

string


Global Location No.

optional

eMail

string


E-mail

optional

ownVessel

boolean


Own Vessel (Landed in Stock)

optional

stockCenterCode

string


Stock Center Code

optional

originalProducer

string


Original Producer

optional

ownersVendorId

string

uuid

SystemId of the vendor in Owners Vendor No.

non-editable

ownersVendorNo

string


Owners Vendor No.

optional

portOfLanding

string


Landing Harbour Code

optional

homePort

string


Home Port

optional

freezerTrawler

boolean


Freezer Trawler

optional

fishingEquipmentCode

string


Fishing Equipment Code

optional

defaultTubCode

string


Default Tub Code

optional

defaultFishingArea

string


Default Fishing Area

optional

defaultLandingType

string


Default Landing Type

optional

defaultRawMaterialLocation

string


Default Raw Material Location

optional

defaultProductLocation

string


Default Product Location

optional

processingStageAtLanding

string


Processing Stage at Landing

optional

exchangeValueRatioCode

string


Exchange Value Ratio Code

optional

systemRowVersion

integer


System row version. Increments every time the record is modified.

non-editable

lastModified

string

date-time

SystemModifiedAt (date and time of last change)

non-editable


Object Example

An example of one object:

JSON
{
    "@odata.etag": "W/\"JzIwOzEyNzY0NzcyMDMwMjU5MDg1NjM2MTswMDsn\"",
    "code": "BS123",
    "systemId": "cdb0bfcd-6853-f111-b032-a998af6b54b1",
    "name": "my vessel",
    "callSign": "",
    "address": "",
    "countryOfOrigin": "",
    "gln": "",
    "eMail": "",
    "ownVessel": false,
    "stockCenterCode": "",
    "originalProducer": "",
    "ownersVendorId": "00000000-0000-0000-0000-000000000000",
    "ownersVendorNo": "",
    "portOfLanding": "",
    "homePort": "",
    "freezerTrawler": false,
    "fishingEquipmentCode": "",
    "defaultTubCode": "",
    "defaultFishingArea": "",
    "defaultLandingType": "",
    "defaultRawMaterialLocation": "",
    "defaultProductLocation": "",
    "processingStageAtLanding": "",
    "exchangeValueRatioCode": "",
    "systemRowVersion": 2582338,
    "lastModified": "2026-05-19T09:55:25.867Z"
}


Examples

Read vessels

Read all entries

Reads all vessels. The response is a list of vessel objects, as shown in Object Example.

GET
.../vessels

Read a specific entry

To read vessel with code ‘BS123’:

GET
.../vessels('BS123')

Read own vessels with selected properties

Reads only the code, name, call sign and stock center of the own vessels (landed in stock), using $filter and $select (the response is shortened).

Request:

JSON
GET .../vessels?$filter=ownVessel eq true&$select=code,name,callSign,stockCenterCode

Response:

JSON
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#vessels(code,name,callSign,stockCenterCode)",
    "value": [
        {
            "@odata.etag": "W/\"JzIwOzE2NzY0NzcyMDMwMjU5MDg1NjM2MjswMDsn\"",
            "code": "BS124",
            "name": "Northern Star",
            "callSign": "TFNS",
            "stockCenterCode": ""
        }
    ]
}


Create, change and delete vessels

Create a new vessel

Creates the own vessel BS124 with a name and a call sign.

Request:

JSON
POST .../vessels

Body:
{
    "code": "BS124",
    "name": "Northern Star",
    "callSign": "TFNS",
    "ownVessel": true
}

Response:

JSON
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#vessels/$entity",
    "@odata.etag": "W/\"JzIwOzE2NzY0NzcyMDMwMjU5MDg1NjM2MjswMDsn\"",
    "code": "BS124",
    "systemId": "4e7a1c22-8f53-f111-b032-a998af6b54b1",
    "name": "Northern Star",
    "callSign": "TFNS",
    "address": "",
    "countryOfOrigin": "",
    "gln": "",
    "eMail": "",
    "ownVessel": true,
    "stockCenterCode": "",
    "originalProducer": "",
    "ownersVendorId": "00000000-0000-0000-0000-000000000000",
    "ownersVendorNo": "",
    "portOfLanding": "",
    "homePort": "",
    "freezerTrawler": false,
    "fishingEquipmentCode": "",
    "defaultTubCode": "",
    "defaultFishingArea": "",
    "defaultLandingType": "",
    "defaultRawMaterialLocation": "",
    "defaultProductLocation": "",
    "processingStageAtLanding": "",
    "exchangeValueRatioCode": "",
    "systemRowVersion": 2582351,
    "lastModified": "2026-05-19T10:12:40.203Z"
}

Change a vessel

Sets the call sign and e-mail of vessel BS123. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON
PATCH .../vessels('BS123')
If-Match: *

Body:
{
    "callSign": "TFAB",
    "eMail": "vessel@example.com"
}

Response:

JSON
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#vessels/$entity",
    "@odata.etag": "W/\"JzIwOzE3Njc0NzcyMDMwMjU5MDg1NjM2MzswMDsn\"",
    "code": "BS123",
    "systemId": "cdb0bfcd-6853-f111-b032-a998af6b54b1",
    "name": "my vessel",
    "callSign": "TFAB",
    "address": "",
    "countryOfOrigin": "",
    "gln": "",
    "eMail": "vessel@example.com",
    "ownVessel": false,
    "stockCenterCode": "",
    "originalProducer": "",
    "ownersVendorId": "00000000-0000-0000-0000-000000000000",
    "ownersVendorNo": "",
    "portOfLanding": "",
    "homePort": "",
    "freezerTrawler": false,
    "fishingEquipmentCode": "",
    "defaultTubCode": "",
    "defaultFishingArea": "",
    "defaultLandingType": "",
    "defaultRawMaterialLocation": "",
    "defaultProductLocation": "",
    "processingStageAtLanding": "",
    "exchangeValueRatioCode": "",
    "systemRowVersion": 2582356,
    "lastModified": "2026-05-19T10:20:03.517Z"
}

Delete a vessel

Deletes vessel BS124. On success the response is empty (HTTP status 204 No Content).

JSON
DELETE .../vessels('BS124')