Locations

A Location is a space where materials are kept.

Attributes

  • id string

  • name string

  • quantity integer

    Amount of items at this location.

Endpoints

List Locations

get /api/locations

Arguments

Request with curl
curl "http://[Your IP]/api/locations" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "locations": [{ "id": "string", "name": "string", "quantity": "integer", }] }] }

Show Location

get /api/locations/[id]

Get a single location from the PPG database and return a JSON response.

Arguments

  • binDepth Integer

  • binId uuid

  • binWidth Integer

  • contents

  • currentQuantity Integer

  • depth Integer

  • expectedQuantity Integer

  • fillLevel Integer

  • id uuid

  • isMarkedFull integer

  • name String

  • orientationType Integer

  • shelfId uuid

  • subType Integer

  • type Integer

  • width Integer

  • xCoordinate Integer

  • yCoordinate Integer

  • zoneId uuid

Request with curl
curl "http://[Your IP]/api/locations/[id]" \ -X get \-H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "location": { "id": "string", "name": "string", "quantity": integer, } }