Skip to main content

Avatars

Introduction​

The API provides the Avatar information like location/person name, code, parentid, avatarHierarchy starting with parent to child hierarchy names for the Brand, Business Unit, Hospital as Type.

Endpoint​

GEThttps://api1.consumerism.pressganey.com/api/service/v1/access/avatars

Query Parameters​

PropertyTypeDescriptionRequired/Optional
accessTokenStringAccess token for authentication. This access token is valid until the expiry time indicated in the response.Required
typeStringType for which avatar details needed like Hospital , BrandOptional

JSON Response​

A JSON object containing the latest comments.

Sample JSON Response

{
"avatars": [
{
"person": {
"code": "",
"name": ""
},
"name": "Vencava Imaging Centers West",
"location": {
"code": "520820",
"name": "Vencava Imaging Centers West",
"avatarHierarchy": "ACME Healthcare ; Hospital ; National - Hospital ; East Region - Hospital ; Central Market - East Region - Hospital"
},
"parentNodeId": 270702,
"type": "Hospital",
"nodeId": 866817
},
{
"person": {
"code": "",
"name": ""
},
"name": "ACME Regional Hospital",
"location": {
"code": "48784",
"name": "ACME Regional Hospital",
"avatarHierarchy": "ACME Healthcare ; Hospital ; National - Hospital ; Western - Hospital ; Pacific - Western-Hospital"
},
"parentNodeId": 1982687,
"type": "Hospital",
"nodeId": 72728
}
]
}

JSON Response Tags​

PropertyTypeDescription
avatarObjectThe Avatar access details
personObjectPerson/Provider details
CodeStringPerson code
nameStringPerson Name
locationObjectLocation details
CodeStringLocation code
nameStringLocation Name
avatarHierarchyStringThis gives avatar hierarchy for the location selected.
parentNodeIdStringparent node ID
typeStringThis contains the value for which avatar details requested for.