Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

GET /api/v2/job_track/stations

This endpoint is used to retrieve information on all job tracker stations registered in Rx-Universe

image-20240112-143241.png

Accepts

  • A limit. If provided only this many job tracker station records will be returned. Please note that the default value of 10 listed in swagger is the default value set for the Swagger UI only - calling the endpoint without a limit from your system will return all records, not 10.

  • An offset. This is intended for use with the limit to retrieve records in batches. "limit": 10, "offset": 0 returns the first 10 records; "limit": 10, "offset": 10 retrieves records 11-20; etc.

Returns

Success

  • A JSON object representing the requested job tracker stations

    • The total count of job tracker stations, ignoring provided limit and offset

    • An array of objects representing the requested job tracker stations

Property

Description

code

string

The unique code identifying the job tracker station

desc

string

The text description for the job tracker station

customerDesc

string

The customer description for the station

operator

boolean

If true the station is flagged as an operator.

  • No labels