POST api/v3/Status/SetCurrentStatus
Sets the status/action for the current user.
Request Information
URI Parameters
None.
Body Parameters
StatusInput object with the Status/Action to set.
StatusInputV3Name | Description | Type | Additional information |
---|---|---|---|
Uid |
UserId (GUID/UUID) of the User to set. This field will be ignored if the input is used on a function that is setting status for the current user. |
string |
None. |
Typ |
The ActionType/Status of the user to set for the user. |
integer |
None. |
Rto |
Responding to Id |
integer |
None. |
Geo |
Geolocation coordinates |
string |
None. |
Dtp |
Destination type (Station = 1 or Call = 2) |
integer |
None. |
Not |
Note |
string |
None. |
Request Formats
application/json
Sample:
{ "Uid": "sample string 1", "Typ": 2, "Rto": 3, "Geo": "sample string 4", "Dtp": 5, "Not": "sample string 6" }
application/xml, text/xml
Sample:
<StatusInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Status"> <Dtp>5</Dtp> <Geo>sample string 4</Geo> <Not>sample string 6</Not> <Rto>3</Rto> <Typ>2</Typ> <Uid>sample string 1</Uid> </StatusInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns HttpStatusCode Created if successful, BadRequest otherwise.
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |