Carriers

Attributes

  • id string

    Unique identifier for the object.

Endpoints

List Carriers

get /api/carriers

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

Arguments

  • name string

    The name of the carrier.

  • limit integer

  • offset integer

    Will return items, but only those after the integer amount.

  • 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/carriers" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "carriers": [{ "id": "string", }] }] }

Show Carrier

get /api/carriers/[id]

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

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