API - Lot Catch Origins


Overview

The API lists the catch origins of lots. Each record links a lot to one catch origin and gives the weight of the catch in the lot that comes from that origin (weight).

A lot made from mixed raw material has several records, one per catch origin. Every catch origin always has a vessel, a landing date and a fish type. The fishing area and fishing equipment are taken from the catch origin record and are empty if the catch origin is not found.

The same records are available as the child object catchOrigin on the endpoints lots, originLots and productionLots (?$expand=catchOrigin).

Endpoint name

lotCatchOrigins

Source table

WiFi Lot Catch Origin

Fixed view

There is no fixed filter on this list.

Requests allowed

GET

Primary key

Lot No., Origin ID, Stage

Of these, the endpoint exposes lot (Lot No.) and originId (Origin ID). Stage is not exposed.

Record ID

systemId

Child objects

None

Procedures

None


Data

Field List

Property

Type

Format

Description


1

systemId

string

uuid

SystemId

Record ID

non-editable

2

lot

string

max 20

Lot No. The lot that the catch origin belongs to.

primary key

3

originId

string

max 20

Origin ID. The ID of the catch origin (table WiFi Catch Origin).

primary key

4

weight

number

decimal

Weight. The amount of this origin in this lot, given in the base weight unit of Wisefish.


5

vesselCode

string

max 20

Vessel Code of the catch origin.


6

landingDate

string

date

Landing Date of the catch origin.


7

fishType

string

max 10

Fish Type. The international code for the fish species, always the same as on the catch origin.


8

fishingAreaCode

string

max 10

Fishing Area Code of the catch origin.


9

fishingAreaName

string

max 100

Name of the fishing area of the catch origin.


10

fishingEquipmentCode

string

max 10

Fishing Equipment Code of the catch origin.


11

fishingEquipmentName

string

max 50

Name of the fishing equipment of the catch origin.


12

systemRowVersion

integer


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

non-editable

13

lastModified

string

date-time

SystemModifiedAt (date and time of last change)

non-editable

14

modifiedByUser

string


The user who last modified the record

non-editable

Object Example

JSON
{
    "systemId": "8b31d0e4-6a5f-f111-b030-c053a2f93f8a",
    "lot": "LOT0206",
    "originId": "CO-000123",
    "weight": 1250.5,
    "vesselCode": "2750",
    "landingDate": "2026-04-07",
    "fishType": "COD",
    "fishingAreaCode": "27.5.A",
    "fishingAreaName": "Iceland grounds",
    "fishingEquipmentCode": "TRAWL",
    "fishingEquipmentName": "Bottom trawl",
    "systemRowVersion": 2604415,
    "lastModified": "2026-04-08T09:14:22.517Z",
    "modifiedByUser": "JOHN"
}


Examples

Read lot catch origins

Read all lot catch origins

Reads the catch origins of all lots. The response is a list of objects, as shown in Object Example.

JSON
GET .../lotCatchOrigins

Read one lot catch origin

The Record ID is systemId, so one record is read with a GET request on the following format:

JSON
GET .../lotCatchOrigins(8b31d0e4-6a5f-f111-b030-c053a2f93f8a)

Catch origins of a specific lot

Lists the catch origins of the mixed lot LOT0206 and returns only the origin, weight, vessel, landing date and fish type with $select.

JSON
GET .../lotCatchOrigins?$filter=lot eq 'LOT0206'&$select=lot,originId,weight,vesselCode,landingDate,fishType

Response:

JSON
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/lotCatchOrigins(lot,originId,weight,vesselCode,landingDate,fishType)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzE0NjAyODg4NTcxNDQ4MjM5NDcxOzAwOyc=\"",
            "lot": "LOT0206",
            "originId": "CO-000123",
            "weight": 1250.5,
            "vesselCode": "2750",
            "landingDate": "2026-04-07",
            "fishType": "COD"
        },
        {
            "@odata.etag": "W/\"JzE5OzMzNzk0MjY2Mjc4NTIwNzQ1NjExOzAwOyc=\"",
            "lot": "LOT0206",
            "originId": "CO-000119",
            "weight": 830,
            "vesselCode": "1937",
            "landingDate": "2026-04-06",
            "fishType": "COD"
        }
    ]
}

Lots with catch from a vessel in a period

Lists the lots that contain catch landed by vessel 2750 in April 2026.

JSON
GET .../lotCatchOrigins?$filter=vesselCode eq '2750' and landingDate ge 2026-04-01 and landingDate le 2026-04-30&$select=lot,originId,landingDate,fishType,weight

Read a lot with its catch origins

The catch origins can also be read together with the lot, as the child array catchOrigin on lots, originLots or productionLots.

JSON
GET .../lots('LOT0206')?$expand=catchOrigin