Access Points

An opening of a storage unit where a user can get access.

Attributes

id uuid
Unique identifier for the object.
name string
The name of the access point.
storageUnitId uuid
The ID of the storage unit the access point gives access to.
parameters string
Configuration of an access point's number, index, opposite side (true/false), or use vario light (true/false). These parameters are separated by semicolons, e.g. "AccessPointNumber\\=1;Index\\=1".
isBlocked boolean
Whether the access point is accessible.
blockReason string LIMIT: 50
Reason for blocking the access point from warehouse operations.

Endpoints

List Access Points

get /api/access_points

Get a list of the access points of storage units from the PPG database and return a JSON response.

Arguments

id uuid
Unique identifier for the object.
name string
The name of the access point.
storageUnitId uuid
The ID of the storage unit the access point gives access to.
parameters
Configuration of an access point's number, index, opposite side (true/false), or use vario light (true/false). These parameters are separated by semicolons.
isBlocked boolean
Whether the access point is accessible.
blockReason string LIMIT: 50
Reason for blocking the access point from warehouse operations.
limit integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000.

Default value: 250
page integer
Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.
countOnly boolean
When "true", will only return a count of the amount of items in the query.

Default value: false

Request with curl

curl "http://[Your IP] /api/access_points" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{
    "access_points": [
        {
            "blockReason": null,
            "parameters": "AccessPointNumber\\=1;Index\\=1",
            "name": "Access Point01",
            "isBlocked": 0,
            "id": "40F2C3CA-C38D-43C9-A6BD-3816D78F3115",
            "storageUnitId": "CA1E5648-FA38-416F-9604-CF33A6763496"
        },
        {
            "blockReason": null,
            "parameters": null,
            "name": "Access Point02",
            "isBlocked": 0,
            "id": "29FC6AA4-029E-4074-BFFD-4637AEBBA539",
            "storageUnitId": "4E650810-D8E2-444B-813D-BA0254A37A6C"
        }
    ]
}

Show Access Points

get /api/access_points/[id]

Get info from a specific access point from the PPG database and return a JSON response.

Arguments

Request with curl

curl "http://[Your IP] /api/access_points/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{
    "access_point": {
        "blockReason": null,
        "parameters": null,
        "name": "Access Point01",
        "isBlocked": 0,
        "id": "29FC6AA4-029E-4074-BFFD-4637AEBBA539",
        "storageUnitId": "4E650810-D8E2-444B-813D-BA0254A37A6C"
    }
}