POST (Header:PUT) api.ashx/v2/userpresence/{userid}.{json|xml}
UPDATE a user's presence details by user id.
Scopes
Users › Modify Presence users.presence.modify
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
IsOnline | bool | Is Online | Required | |||
Location | string | Location | Optional | |||
UserId | int? | Either UserId or Username is required. | Optional | |||
Username | string | Either UserId or Username is required. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.put({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/userpresence/{userid}.json', data: { 'userid': '6', 'IsOnline': 'True' } }).then(function(response) { // use response });
Example Responses
JSON
{ "UserId": 6, "Username": "username", "IsOnline": true, "Location": "location", "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <UserId>6</UserId> <Username>username</Username> <IsOnline>true</IsOnline> <Location>location</Location> </Response>
POST (Header:PUT) api.ashx/v2/userpresence/{username}.{json|xml}
UPDATE a user's presence details by username.
Scopes
Users › Modify Presence users.presence.modify
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
IsOnline | bool | Is Online | Required | |||
Location | string | Location | Optional | |||
UserId | int? | Either UserId or Username is required. | Optional | |||
Username | string | Either UserId or Username is required. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.put({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/userpresence/{username}.json', data: { 'username': 'username', 'IsOnline': 'True' } }).then(function(response) { // use response });
Example Responses
JSON
{ "UserId": 6, "Username": "username", "IsOnline": true, "Location": "location", "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <UserId>6</UserId> <Username>username</Username> <IsOnline>true</IsOnline> <Location>location</Location> </Response>