Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Escalation Indexes

Gets one Escalation Indexes object from the cache.

Represents data found in Vista™ HQ Escalation Index program.

Vista views: HQPO, HQPD

get/direct/subscribers/{subscriber_code}/vista/hq/2/data/escalation_indexes/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

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

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

Countrystring required
Statestring required
PriceIndexstring required
Descriptionstring nullable
Factorstring required
MinDaysinteger required
MinAmtstring required
Notesstring nullable
KeyIDinteger required
UniqueAttchIDstring nullable
__custom_fieldsobject

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}