Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Benefit Codes

Gets all Benefit Codes objects from the cache.

Represents data found in Vista™ Human Benefit Codes Master program.

Vista view: HRBC

get/direct/subscribers/{subscriber_code}/vista/hr/2/data/benefit_codes/cache

Path parameters

subscriber_codestring required

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

Query parameters

limitinteger

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.

modifiedUTCSincestring

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.

continuationTokenstring

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-Keystring required

Used to authorize access to the Direct API.

Response

Success

limitinteger required
nextstring required
continuationTokenstring required

Example response

{
  "data": [
    {
      "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
    }
  ]
}