1. Resource Central arrow-right
  2. Stations

Stations

Attributes

  • name string LIMIT: 50

    The name of the station.

  • id uuid

    The unique identifier of the station.

  • description string LIMIT: 80

    The description of the station.

  • dnsName string LIMIT: 50

    The name of the domain name system.

  • type integer

    The type of station.

    Possible values:

    1 = PC
    5 = Web client
    6 = Server
    7 = Mobile Client
    8 = Terminal Client

  • warehouseId uuid

    The ID of the PowerPick warehouse where the station is located.

  • warehouseName string LIMIT: 50

    The name of the PowerPick warehouse where the station is located.

Endpoints

List Stations /api/stations
get

Get a list of stations from the PPG database. View the guide on adding filters to List API calls.

Body Parameters

  • type integer

    The type of station.

    Possible values:

    1 = PC
    5 = Web client
    6 = Server
    7 = Mobile Client
    8 = Terminal Client

  • warehouseId uuid

    The ID of the PowerPick warehouse where the station is location.

  • countOnly boolean

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

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000.

  • 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.

  • orderBy string, array

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/stations" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "stations": [{ "name": " string ", "id": " uuid ", "description": " string ", "dnsName": " string ", "type": " integer ", "warehouseId": " uuid ", "warehouseName": " string ", }] }] }
Show Station /api/station/[id]
get

Body Parameters

  • description string

  • dnsName string

  • id uuid

  • type integer

  • warehouseId uuid

  • 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://[subdomain.itempath.com or IP]/api/station/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "station": { "name": " string " , "id": uuid , "description": " string " , "dnsName": " string " , "type": integer , "warehouseId": uuid , "warehouseName": " string " , } }