API - Landing Types | Wisefish API

Overview

The list page that contains the Landing Types.

Endpoint name	`landingTypes`
Source table	`WiFi Landing Type`
Fixed view	Discarded = false
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 20	The unique id of this entry.	Record ID primary key
`description`	string	max 100	The description of this landing type.	mandatory
`discarded`	boolean		Discarded	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

{
    "systemId": "6f603927-1603-f011-b01d-f992b2580806",
    "code": "01",
    "description": "normal",
    "discarded": false,
    "systemRowVersion": 2576988,
    "lastModified": "2025-03-17T10:12:08.083Z"
}

Examples

Read landing types

Read all landing types

Reads all landing types that are not discarded. The response is a list of landing type objects, as shown in Object Example.

JSON

GET .../landingTypes

Read one landing type

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

JSON

GET .../landingTypes('01')

Read landing types with a filter

Reads the code and description of all landing types whose code starts with 0 (the response is shortened).

Request:

JSON

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

Response:

JSON

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

Create, change and delete landing types

Create a new landing type

Creates the landing type 02. description is mandatory; a POST without it is rejected.

Request:

JSON

POST .../landingTypes

Body:
{
    "code": "02",
    "description": "frozen at sea"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/landingTypes/$entity",
    "@odata.etag": "W/\"JzE5OzE4MjczNjQ1MDkxODI3MzY0NTUxOzAwOyc=\"",
    "systemId": "c81f4a92-6b2e-f111-b02a-8bca792786d1",
    "code": "02",
    "description": "frozen at sea",
    "discarded": false,
    "systemRowVersion": 2581990,
    "lastModified": "2025-12-19T11:31:05.412Z"
}

Change a landing type

Changes the description of landing type 02. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON

PATCH .../landingTypes('02')
If-Match: *

Body:
{
    "description": "frozen on board"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/landingTypes/$entity",
    "@odata.etag": "W/\"JzE5OzU1MDI4MzkxNzQ2MjAxOTM4NDcxOzAwOyc=\"",
    "systemId": "c81f4a92-6b2e-f111-b02a-8bca792786d1",
    "code": "02",
    "description": "frozen on board",
    "discarded": false,
    "systemRowVersion": 2582004,
    "lastModified": "2025-12-19T11:38:47.926Z"
}

Delete a landing type

Deletes landing type 02. On success the response is empty (HTTP status 204 No Content).

JSON

DELETE .../landingTypes('02')