Profile Route¶
Routes¶
FindAll¶
GET <base_url>/profiles
Authentication: Required
Returns all profiles from the system that the user has access to Parameters ^^^^^^^^^^
Query¶
Name |
Description |
Type |
Default Value |
|---|---|---|---|
limit |
The maximimum number of results to return. Cannot exceed |
number |
|
skip |
The number of items to skip in the results (pagination). |
number |
|
sort |
An object containing the name of the member to sort by and the order in which to sort. |
object |
|
Create¶
POST <base_url>/profiles
Authentication: Required
Create a new profile. Parameters ^^^^^^^^^^
Count¶
GET <base_url>/profiles/count
Authentication: Required
Returns the count of profiles Parameters ^^^^^^^^^^
FindById¶
GET <base_url>/profiles/:id
Authentication: Required
Returns a single profile from the system that the user has access to Parameters ^^^^^^^^^^ * Name id
Update¶
PUT <base_url>/profiles/:id
Authentication: Required
Updates a single profile Parameters ^^^^^^^^^^ * Name id
Delete¶
DELETE <base_url>/profiles/:id
Authentication: Required
Deletes the profile Parameters ^^^^^^^^^^ * Name id
FindByUserUid¶
GET <base_url>/profiles/:userUid/profile
Authentication: Required
Returns the profile from the system for the given user. Parameters ^^^^^^^^^^ * Name userUid
UpdateByUserUid¶
PUT <base_url>/profiles/:userUid/profile
Authentication: Required
Creates or updates the profile for the given user. Parameters ^^^^^^^^^^ * Name userUid
DeleteByUserUid¶
DELETE <base_url>/profiles/:userUid/profile
Authentication: Required
Deletes the profile for the given user. Parameters ^^^^^^^^^^ * Name userUid
GetUserPresence¶
GET <base_url>/profiles/:userUid/profile/presence
Authentication: Required
Returns the profile presence data for the given user. Parameters ^^^^^^^^^^ * Name userUid
SetUserPresence¶
PUT <base_url>/profiles/:userUid/profile/presence
Authentication: Required
Sets the profile presence data for the given user. Parameters ^^^^^^^^^^ * Name userUid