Parameters, Fields & Filters

Parameters

The different endpoints of the chayns Backend API often use the same parameters. Here is an overview of the basic parameters that every user of the API should know.

LocationID
The ID of the current location. Can be found in the chayns.env.site object.

TappID
The ID of the current tapp. Can be found in the chayns.env.site.tapp object.

UserID
The ID of the user, that is currently logged in. Can be found in the chayns.env.user object.

GroupID
The ID of a UAC group. It can be found in the chayns.env.site.tapp.userGroupIds object or in the chayns.env.user.groups object.

DeviceID (apps only)
UID of the users device. Can be found in the chayns.env.device object.

---

Fields and Filters

Fields and filters are helpful to precise the request and to limit the returned data to the data you really need.

Fields
Use fields to get just the information you need. Append them as url parameters, the values are comma-separated.
https://api.chayns.net/v2.0/{LocationID}/User?fields=firstName,lastName
This will return the name of each user of the given location. The fields are named exactly the same as the results of each request.

Filters
Your request will return only the results matching your filter. Append them as url parameters.
https://api.chayns.net/v2.0/{LocationID}/User?gender=female
This will return all female users of the given location.