API - User Profiles | Wisefish API

Overview

The list page that contains the User Profiles. Every user of Wisefish must have an active User Profile.

Endpoint name	`userProfiles`
Source table	`WiFi User Profile`
Fixed view
Requests allowed	GET, PATCH
Primary key	Code
Record ID	code
Procedures	None

Data

Field List

Property	Type	Format	Description
`code`	string	max 10	The unique id of this profile.	Record ID primary key
`systemId`	string	uuid	SystemId	non-editable
`description`	string	max 50	Description of this User Profile	optional
`locationId`	string	uuid	SystemId of the location in Location Code	non-editable
`locationCode`	string	max 10	Location Code	optional
`stockCenterId`	string	uuid	SystemId of the stock center in Stock Center Code	non-editable
`stockCenterCode`	string	max 20	Stock Center Code	optional
`allowPosAdjmtToProdLot`	boolean		Allow Positive Adjmt to Production Lot	optional
`postingStdDocOptions`	string	enum	Posting Std. Doc. Options	optional
`postingSales`	string	enum	Posting Sales Documents	optional
`postingPurchases`	string	enum	Posting Purchase Documents	optional
`postingTransferDocuments`	string	enum	Posting Transfer Documents	optional
`reopenRAinPosting`	boolean		Reopen Receipt Agreement in Posting	optional
`reopenDAinPosting`	boolean		Reopen Delivery Agreement in Posting	optional
`allowByPassScheduledTrip`	boolean		Allow Bypass Scheduled Trip Check in Releasing of a Delivery Agreement	optional
`stage`	string	max 20	Stage	optional
`consumptionStage`	string	max 20	Consumption Stage	optional
`addToOpenPallet`	boolean		Add to Open Pallet	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

{
    "code": "INSIDE",
    "systemId": "d11b2438-a28f-ef11-b015-ea34eb14d1c3",
    "description": "Inside warehouse man",
    "locationId": "57cb189f-dd11-ef11-9f8b-6045bde9cc61",
    "locationCode": "BLUE",
    "stockCenterId": "00000000-0000-0000-0000-000000000000",
    "stockCenterCode": "",
    "allowPosAdjmtToProdLot": false,
    "postingStdDocOptions": "Both",
    "postingSales": "Both",
    "postingPurchases": "Both",
    "postingTransferDocuments": "Allowed",
    "reopenRAinPosting": false,
    "reopenDAinPosting": false,
    "allowByPassScheduledTrip": false,
    "stage": "PRODUCTION",
    "consumptionStage": "CONSUMPTION",
    "addToOpenPallet": false,
    "systemRowVersion": 2580970,
    "lastModified": "2025-08-26T16:18:30.957Z"
}

Examples

Read user profiles

Read all entries

Reads all user profiles. The response is a list of user profile objects, as shown in Object Example.

JSON

GET
.../userProfiles

Read a specific entry

The Record ID is the user profile code itself, so one user profile is read with a GET request on the following format:

JSON

GET
.../userProfiles('INSIDE')

Read the user profiles of a location

Reads the user profiles with location BLUE, and returns only a few fields with $select.

Request:

JSON

GET .../userProfiles?$filter=locationCode eq 'BLUE'&$select=code,description,stage,consumptionStage

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/userProfiles(code,description,stage,consumptionStage)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzE4NzM0NTkwMjIxMzQ1Njc4OTAxOzAwOyc=\"",
            "code": "INSIDE",
            "description": "Inside warehouse man",
            "stage": "PRODUCTION",
            "consumptionStage": "CONSUMPTION"
        }
    ]
}

Change user profiles

Change a user profile

Turns on Add to Open Pallet for user profile INSIDE. A PATCH request needs the If-Match header with the @odata.etag of the record (or *). User profiles cannot be created or deleted through the API.

Request:

JSON

PATCH .../userProfiles('INSIDE')
If-Match: *

Body:
{
    "addToOpenPallet": true
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/userProfiles/$entity",
    "@odata.etag": "W/\"JzE5OzcyNjQ1MTkzODIwMTc0NjUzOTIxOzAwOyc=\"",
    "code": "INSIDE",
    "systemId": "d11b2438-a28f-ef11-b015-ea34eb14d1c3",
    "description": "Inside warehouse man",
    "locationId": "57cb189f-dd11-ef11-9f8b-6045bde9cc61",
    "locationCode": "BLUE",
    "stockCenterId": "00000000-0000-0000-0000-000000000000",
    "stockCenterCode": "",
    "allowPosAdjmtToProdLot": false,
    "postingStdDocOptions": "Both",
    "postingSales": "Both",
    "postingPurchases": "Both",
    "postingTransferDocuments": "Allowed",
    "reopenRAinPosting": false,
    "reopenDAinPosting": false,
    "allowByPassScheduledTrip": false,
    "stage": "PRODUCTION",
    "consumptionStage": "CONSUMPTION",
    "addToOpenPallet": true,
    "systemRowVersion": 2582017,
    "lastModified": "2025-12-18T15:02:11.380Z"
}