POST api/classe/driveraccount
Request a token for a driver
Request Information
URI Parameters
None.
Body Parameters
The login request being made
ClasseDriverLoginRequestModelName | Description | Type | Additional information |
---|---|---|---|
Username |
The driver username you are logging in as |
string |
None. |
Password |
The driver password you are logging in as |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Username": "sample string 1", "Password": "sample string 2" }
application/xml, text/xml
Sample:
<ClasseDriverLoginRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Username>sample string 1</Username> <Password>sample string 2</Password> </ClasseDriverLoginRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A login response model
ClasseDriverLoginResponseModelName | Description | Type | Additional information |
---|---|---|---|
DriverID |
The ID of the authenticated driver |
unsigned integer |
None. |
DriverName |
The name of the driver |
string |
None. |
DriverTelephoneNumber |
The telephone number of the driver |
string |
None. |
DriverRegion |
The region of the driver |
string |
None. |
Authenticated |
A flag to show if the user is authenticated or not |
boolean |
None. |
AuthenticationToken |
The authentication token for this user session |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "DriverID": 1, "DriverName": "sample string 2", "DriverTelephoneNumber": "sample string 3", "DriverRegion": "sample string 4", "Authenticated": true, "AuthenticationToken": "sample string 6" }
application/xml, text/xml
Sample:
<ClasseDriverLoginResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DriverID>1</DriverID> <DriverName>sample string 2</DriverName> <DriverTelephoneNumber>sample string 3</DriverTelephoneNumber> <DriverRegion>sample string 4</DriverRegion> <Authenticated>true</Authenticated> <AuthenticationToken>sample string 6</AuthenticationToken> </ClasseDriverLoginResponseModel>