-
Notifications
You must be signed in to change notification settings - Fork 0
Reference Group Member
This method will get information about all members of an UAC group. It returns one object for each member.
GET https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}/User?[filter=value]
Permissions
'PublicInfo', 'UserInfo', 'SeeUAC'
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.
- GroupID : int - Can be found in chayns.env.
Filter
FirstName, LastName, Name, Gender
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.
This method will get information about a specific member of an UAC group.
GET https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}/User/{UserID}
Snippet
Permissions
'PublicInfo', 'UserInfo', 'SeeUAC'
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.
- GroupID : int - Can be found in chayns.env.
- UserID : int - Can be found in chayns.env.user.
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.
This method adds a user to a specific Tapp-UAC group. It returns information about the added user.
Tapp UAC groups are based on the installed Developer Tapp. If the Tapp is deleted, the UAC group will be removed automaticly.
POST https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}/User/{UserID}
Snippet
Permissions
'PublicInfo', 'UserInfo', 'SeeUAC', 'EditUAC'
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.
- GroupID : int - Can be found in chayns.env.
- UserID : int - Can be found in chayns.env.user.
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.
This method removes a User from a Tapp-UAC group.
Tapp UAC groups are based on the installed Developer Tapp. If the Tapp is deleted, the UAC group will be removed automaticly.
DELTE https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}/User/{UserID}
Permissions
'PublicInfo', 'UserInfo', 'SeeUAC', 'EditUAC'
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.
- GroupID : int - Can be found in chayns.env.
- UserID : int - Can be found in chayns.env.user.
The current API version is v2.0 .
To use the chayns Backend API, you have to be registered in the Tobit.Software Partner Network (TSPN).
To register, please visit tobit.software/Partner.