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

    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/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 " , } }