Reference User

Table of Contents

• Get all Users
• Get User
• Get UAC Groups
• Get all Devices from user
• Get Device from user

Get all users

This method will get information about all users of this site. It returns one object for each user.

GET https://api.chayns.net/v2.0/{LocationID}/User[?filter=value]

Permissions
'PublicInfo', 'UserInfo'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• TappID : int - Can be found in chayns.env.site.tapp

Filter
FirstName, LastName, Name, Gender, PersonId

Result

• firstName : string - The first name of the current user.
• lastName : string - The last name.
• name : string - The full name of the user.
• picture : string - The url to the users facebook profile picture.
• gender : string - The gender of the current user.
• userId : int - The userId,
• personId : string - The users personId.
• countGroups : int - The count of the users groups.

---

Get user

This method will get information about a specific user.

GET https://api.chayns.net/v2.0/{LocationID}/User/{UserID}

Permissions
'PublicInfo', 'UserInfo'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• UserID : int - Can be found in chayns.env.user.
• TappID : int - Can be found in chayns.env.site.tapp.

Result

• firstName : string - The first name of the current user.
• lastName : string - The last name.
• name : string - The full name of the user.
• picture : string - The url to the users facebook profile picture.
• gender : string - The gender of the current user.
• userId : int - The userId,
• personId : string - The users personId.
• countGroups : int - The count of the users groups.

---

Get UAC Groups

This method lists all the UAC groups of the user that belongs to the location. It returns one object for each group.

GET https://api.chayns.net/v2.0/{LocationID}/User/{UserID}/UAC[?filter=value]

Permissions
'PublicInfo', 'UserInfo'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• UserID : int - Can be found in chayns.env.user.
• TappID : int - Can be found in chayns.env.site.tapp.

Filter
Name, ShowName, TappId

Result

• name : string - The internal name of the UAC group.
• showName : string - The public showname of the UAC group.
• userGroupId : int - The id of the UAC group.
• countMember : int - The count of all members of this UAC group.

---

Get all Devices from User

This method lists all registered devices of the user. It returns one object for each device.

GET https://api.chayns.net/v2.0/{LocationID}/User/{UserID}/Device[?filter=value]

Permissions
'PublicInfo', 'UserInfo', 'DeviceInfo'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• UserID : int - Can be found in chayns.env.user.
• TappID : int - Can be found in chayns.env.site.tapp.

Filter
Udid, SysName, SysVersion, AppVersion

Result

• sysName : string - The name of the running OS.
• sysVersion : string - The OS version of the device running the app.
• lastRequest : string - The last recognized use of the app using that specific device.
• deviceToken : string - A token generated for the device.
• udid : string - The unique device identifier.
• deviceId : int - An internal id of the device.
• appVersion : int - The last recognized version of the app that is used on that specific device.

---

Get Device from User

This method lists all registered devices of the user. It returns one object for each device.

GET https://api.chayns.net/v2.0/{LocationID}/User/{UserID}/Device/{DeviceID}

Permissions
'PublicInfo', 'UserInfo', 'DeviceInfo'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• UserID : int - Can be found in chayns.env.user.
• TappID : int - Can be found in chayns.env.site.tapp.
• DeviceID : int - Can be found using 'Get all Devices from User'.

Result

• sysName : string - The name of the running OS.
• sysVersion : string - The OS version of the device running the app.
• lastRequest : string - The last recognized use of the app using that specific device.
• deviceToken : string - A token generated for the device.
• udid : string - The unique device identifier.
• deviceId : int - An internal id of the device.
• appVersion : int - The last recognized version of the app that is used on that specific device.

---