POST token/IsUserOnline

Request Information

URI Parameters

None.

Body Parameters

IsUserOnlineInput
NameDescriptionTypeAdditional information
UserID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "UserID": 1
}

application/xml, text/xml

Sample:
<IsUserOnlineInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Auth.ServiceUser">
  <UserID>1</UserID>
</IsUserOnlineInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IsUserOnlineInput'.

Response Information

Resource Description

IsUserOnlineOutput
NameDescriptionTypeAdditional information
IsOnline

boolean

None.

SessionCount

integer

None.

ReturnStatus

ReturnStatusModel

None.

Response Formats

application/json, text/json

Sample:
{
  "IsOnline": true,
  "SessionCount": 2,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:
<IsUserOnlineOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Auth.ServiceUser">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <IsOnline>true</IsOnline>
  <SessionCount>2</SessionCount>
</IsUserOnlineOutput>