POST api/account
POST api/account Example - http://restapi.matrixtelematics.com/api/Account { "username": "yourusername", "password": "yourpassword" }
Request Information
URI Parameters
None.
Body Parameters
ObjectNone.
Request Formats
application/json, text/json
Sample:
{}
application/xml, text/xml
Sample:
<anyType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LoginResponseName | Description | Type | Additional information |
---|---|---|---|
UserID |
The ID of the authenticated user |
unsigned integer |
None. |
Authenticated |
A flag to show if the user is authenticated or not |
boolean |
None. |
BrandingID |
An identifier for the branding that needs to be applied for this user |
unsigned integer |
None. |
Name |
A display name for the user |
string |
None. |
AuthenticationToken |
The authentication token for this user session |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserID": 1, "Authenticated": true, "BrandingID": 3, "Name": "sample string 4", "AuthenticationToken": "sample string 5" }
application/xml, text/xml
Sample:
<LoginResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <UserID>1</UserID> <Authenticated>true</Authenticated> <BrandingID>3</BrandingID> <Name>sample string 4</Name> <AuthenticationToken>sample string 5</AuthenticationToken> </LoginResponse>