Gets all Earn Types objects from the cache.

get https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/hq/2/data/earn_types/cache

Represents data found in Viewpoint® Vista™ HQ Earn Types program.

Vista view: HQET

Path Params

subscriber_code

string

required

The code of the subscriber that you are making this request for.

Query Params

limit

integer

Limits the number of records returned by the API, up to a maximum of 1,000. The API may return less than the limit even when more records exist. Always examine the 'next' and 'continuationToken' properties to determin if more records are available.

modifiedUTCSince

string

A string specifies a datetime against which to filter the results. When specified the result will be ordered oldest __modifiedUTC to newest. Example 2019-12-11T20:16:58.3419275Z. Optional. If unspecified, all cached objects will be returned.

continuationToken

string

A URL Encoded continuationToken value from a previous GET response. When provided, the next set of results for the original GET will be returned.

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/hq/2/data/earn_types/cache \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.