API - Fishing Areas | Wisefish API

Overview

The list page that contains the Fishing Areas.

Endpoint name	`fishingAreas`
Source table	`WiFi Fishing Area`
Fixed view
Requests allowed	GET, POST, PATCH, DELETE
Primary key	Code
Record ID	`code`
Procedures	None

Data

Field List

Property	Type	Format	Description
`systemId`	string	uuid	System ID. This is really not needed because the `code` is the record ID.	non-editable
`code`	string	max 10	The unique id of this entry.	Record ID primary key
`description`	string	max 100	Description of the fishing area.	recommended
`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

{
    "code": "SW",
    "systemId": "79916e5c-9697-f011-b026-d12be11d849b",
    "description": "South West",
    "systemRowVersion": 2577310,
    "lastModified": "2025-09-22T09:27:34.277Z"
}

Examples

Read fishing areas

Read all fishing areas

Reads all fishing areas. The response is a list of fishing area objects, as shown in Object Example.

JSON

GET .../fishingAreas

Read one fishing area

The record ID is the code of the fishing area, so one entry is read with the code in the URL:

JSON

GET .../fishingAreas('SW')

Read fishing areas with a filter

Reads the code and description of all fishing areas whose description starts with “South” (the response is shortened).

Request:

JSON

GET .../fishingAreas?$filter=startswith(description,'South')&$select=code,description

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/fishingAreas(code,description)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzE1NzQ4MjkzMDYyNzE4NDM1ODcxOzAwOyc=\"",
            "code": "SW",
            "description": "South West"
        }
    ]
}

Create, change and delete fishing areas

Create a new fishing area

Creates the fishing area NW. code and description are given; the other properties are set by the system.

Request:

JSON

POST .../fishingAreas

Body:
{
    "code": "NW",
    "description": "North West"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/fishingAreas/$entity",
    "@odata.etag": "W/\"JzE5OzM2NDg5MjcxNTUwMjc4MzQ5MTgxOzAwOyc=\"",
    "code": "NW",
    "systemId": "a3c41b0e-2f6d-f111-b02a-8bca792786d1",
    "description": "North West",
    "systemRowVersion": 2581910,
    "lastModified": "2025-12-19T10:12:44.530Z"
}

Change a fishing area

Changes the description of fishing area NW. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON

PATCH .../fishingAreas('NW')
If-Match: *

Body:
{
    "description": "North West coast"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/fishingAreas/$entity",
    "@odata.etag": "W/\"JzE5OzkxMjM4NDc1NjAxOTI4Mzc0NjUxOzAwOyc=\"",
    "code": "NW",
    "systemId": "a3c41b0e-2f6d-f111-b02a-8bca792786d1",
    "description": "North West coast",
    "systemRowVersion": 2581935,
    "lastModified": "2025-12-19T10:20:03.117Z"
}

Delete a fishing area

Deletes fishing area NW. On success the response is empty (HTTP status 204 No Content).

JSON

DELETE .../fishingAreas('NW')