API - Vessels | Wisefish Manuals

Overview

The list of Vessels.

Endpoint name	`vessels`
Source table	`WiFi Vessel`
Fixed view
Requests allowed	GET, POST, PATCH, DELETE
Primary key	“No.”
Record ID	`code`
Procedures

Data

Field List

Property	Type	Format	Description
`code`	string
`systemId`	string	uuid		non-editable
`name`	string
`callSign`	string
`address`	string
`countryOfOrigin`	string
`gln`	string
`eMail`	string
`ownVessel`	boolean
`stockCenterCode`	string
`originalProducer`	string
`ownersVendorId`	string	uuid
`ownersVendorNo`	string
`portOfLanding`	string
`homePort`	string
`freezerTrawler`	boolean
`fishingEquipmentCode`	string
`defaultTubCode`	string
`defaultFishingArea`	string
`defaultLandingType`	string
`defaultRawMaterialLocation`	string
`defaultProductLocation`	string
`processingStageAtLanding`	string
`exchangeValueRatioCode`	string
`systemRowVersion`	integer			non-editable
`lastModified`	string	date-time		non-editable

Example Object

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"
}

Usage

Read all entries

GET
.../vessels

Read a specific entry

To read vessel with code ‘BS123’:

GET
.../vessel('BS123')