GET /profiles
Authentication: Required
Returns all profiles from the system that the user has access to
Name | Description | Type | Default Value |
---|---|---|---|
limit | The maximimum number of results to return. Cannot exceed 1000 . |
number | 100 |
skip | The number of items to skip in the results (pagination). | number | 0 |
sort | An object containing the name of the member to sort by and the order in which to sort. | object | `{ member: “<ASC |
GET /profiles
Authorization: jwt <token>
200 OK
Content-Type: application/json
{}
POST /profiles
Authentication: Required
Create a new profile.
POST /profiles
Content-Type: application/json
Authorization: jwt <token>
{
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
201 CREATED
Content-Type: application/json
{
"uid": "9ff78212-8447-4cd6-b100-9791d7e9d47b",
"dateCreated": "2019-07-05T22:50:13.326Z",
"dateModified": "2019-07-05T22:50:13.326Z",
"version": 0,
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
GET /profiles/count
Authentication: Required
Returns the count of profiles
GET /profiles/count
Authorization: jwt <token>
200 OK
Content-Type: application/json
{
"count": 0
}
GET /profiles/{id}
Authentication: Required
Returns a single profile from the system that the user has access to
Name |
---|
id |
GET /profiles/{id}
Authorization: jwt <token>
200 OK
Content-Type: application/json
{
"uid": "9ff78212-8447-4cd6-b100-9791d7e9d47b",
"dateCreated": "2019-07-05T22:50:13.326Z",
"dateModified": "2019-07-05T22:50:13.326Z",
"version": 0,
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
PUT /profiles/{id}
Authentication: Required
Updates a single profile
Name |
---|
id |
PUT /profiles/{id}
Content-Type: application/json
Authorization: jwt <token>
{
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
200 OK
Content-Type: application/json
{
"uid": "9ff78212-8447-4cd6-b100-9791d7e9d47b",
"dateCreated": "2019-07-05T22:50:13.326Z",
"dateModified": "2019-07-05T22:50:13.326Z",
"version": 0,
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
DELETE /profiles/{id}
Authentication: Required
Deletes the profile
Name |
---|
id |
DELETE /profiles/{id}
Authorization: jwt <token>
200 OK
GET /{userUid}/profile
Authentication: Required
Returns the profile from the system for the given user.
Name |
---|
userUid |
GET /{userUid}/profile
Authorization: jwt <token>
200 OK
Content-Type: application/json
{
"uid": "9ff78212-8447-4cd6-b100-9791d7e9d47b",
"dateCreated": "2019-07-05T22:50:13.326Z",
"dateModified": "2019-07-05T22:50:13.326Z",
"version": 0,
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
PUT /{userUid}/profile
Authentication: Required
Creates or updates the profile for the given user.
Name |
---|
userUid |
PUT /{userUid}/profile
Content-Type: application/json
Authorization: jwt <token>
{
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
200 OK
Content-Type: application/json
{
"uid": "9ff78212-8447-4cd6-b100-9791d7e9d47b",
"dateCreated": "2019-07-05T22:50:13.326Z",
"dateModified": "2019-07-05T22:50:13.326Z",
"version": 0,
"alias": "acceleratxr",
"avatar": "https://en.gravatar.com/acceleratxr 9c638e52-7dbe-4f11-97a9-648da49138bf",
"data": {
"twitter": "acceleratxr",
"bio": "This is my biography.",
"location": "Los Angeles, CA, USA"
},
"presence": "ONLINE"
}
DELETE /{userUid}/profile
Authentication: Required
Deletes the profile for the given user.
Name |
---|
userUid |
DELETE /{userUid}/profile
Authorization: jwt <token>
200 OK
GET /{userUid}/profile/presence
Authentication: Required
Returns the profile presence data for the given user.
Name |
---|
userUid |
GET /{userUid}/profile/presence
Authorization: jwt <token>
200 OK
Content-Type: application/json
{}
PUT /{userUid}/profile/presence
Authentication: Required
Sets the profile presence data for the given user.
Name |
---|
userUid |
PUT /{userUid}/profile/presence
Content-Type: application/json
Authorization: jwt <token>
{}
204 NO CONTENT