Bins

Attributes

  • id uuid

    Unique identifier for the object.

  • name string

    The name of the bin.

  • type integer

  • width integer

  • depth integer

  • height integer

  • color integer

Endpoints

List Bins

get /api/bins

Get the bins from the PPG database and return a JSON response.

Arguments

  • name string

  • limit integer

  • offset integer

  • countOnly boolean

    When true, will only return a count of the amount of items in the query.

Request with curl
curl "http://[Your IP]/api/bins" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "bins": [{ "id": "1CFA1626-B75F-408B-9F41-0006A8EBE9E3", "name": "S-09X03", "type": "1", "width": "integer", "depth": "integer", "height": "integer", "color": "16777215", }] }] }

Show Bin

get /api/bins/[id]

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

Request with curl
curl "http://[Your IP]/api/bins/[id]" \ -X get \-H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "bin": { "id": 1CFA1626-B75F-408B-9F41-0006A8EBE9E3, "name": "S-09X03", "type": 1, "width": integer, "depth": integer, "height": integer, "color": 16777215, } }