Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated with new look + changes from Cindy

Description

POST

/:site_number/account/userstatus

Returns the status of the user name username and password currently supplied.

...

Example

title
Info
Available Status Codes

0 – Active

1 – Deactivated

2 – Expired Password

3 – Invalid User Name or Password

4 – Account Locked

Request Verb

GET

URL

 

Code Block
iconfalse

https://secure.accessacs.com/api_accessacs_mobile/v2/

<sitenumber>

12345/account/

UserStatus

Request Header

...

Query Parameters

...

userstatus


{

 username: "david",
 password: "david",
}

Required Permissions

The user must fall into one of the categories below:

  • System Administration

  • A staff member with manage user rights

Request Header

Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.

username: "jadams"

password: "password231"

URL Parameters

Site_number – Site number to gather data for.

...

JSON

...

Body Text

Code Block
[username: Username provided to retrieve status for.
password: Password of user to provide status for.

Return Data

Code Block
{
     "StatusCode": 0,
     "StatusDescription": "Active"
  }
]

Notes

Available Status Codes

0Active
1Deactivated
2Expired Password
3Invalid Username or Password
4Account Locked