POST api/User/GetUserToken

Get user authenticated and returns token, status code, userchannel and expire date.

Request Information

URI Parameters

None.

Body Parameters

User credential details

Name	Description	Type	Additional information
DeviceInfo	DeviceInfo property.	DeviceInfo	None.
HasIccCard	HasIccCard property.	boolean	None.
IccIds	IccIds property.	Collection of string	None.
IMEI	IMEI property.	string	None.
OsVersion	Os Version property.	AndroidVersion	None.
RapidlotVersion	RapidlotVersion property.	string	None.
UserName	UserName property.	string	None.
Password	Password property.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "deviceInfo": {
    "manufacturer": "sample string 1",
    "model": "sample string 2"
  },
  "hasIccCard": true,
  "iccIds": [
    "sample string 1",
    "sample string 2"
  ],
  "imei": "sample string 1",
  "osVersion": {
    "api": 1,
    "name": "sample string 2"
  },
  "rapidlotVersion": "sample string 2",
  "userName": "sample string 3",
  "password": "sample string 4"
}

application/xml, text/xml

Sample:

<UserCredentialModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DeviceInfo>
    <Manufacturer>sample string 1</Manufacturer>
    <Model>sample string 2</Model>
  </DeviceInfo>
  <HasIccCard>true</HasIccCard>
  <IccIds>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </IccIds>
  <IMEI>sample string 1</IMEI>
  <OsVersion>
    <Api>1</Api>
    <Name>sample string 2</Name>
  </OsVersion>
  <RapidlotVersion>sample string 2</RapidlotVersion>
  <UserName>sample string 3</UserName>
  <Password>sample string 4</Password>
</UserCredentialModel>

Response Information

returns user token with status code 200 if user name and password are right and successfully authenticated, returns status code 401 if user name/password is blank returns status code 500 in case it fails to generate valid token returns status code 400 in case it username/password is incorrect

Response body formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "expire": "2025-06-06T19:32:44.2145375-04:00",
  "isSyncGatewayEnabled": true,
  "message": "",
  "userChannel": null,
  "userDetailsAsw": {
    "deleted": true,
    "dealerList": [
      {
        "dealerLotKey": 1,
        "dealerName": "sample string 2",
        "franchiseKey": 3,
        "isTestDealer": true
      },
      {
        "dealerLotKey": 1,
        "dealerName": "sample string 2",
        "franchiseKey": 3,
        "isTestDealer": true
      }
    ],
    "emailId": "sample string 2",
    "firstName": "sample string 3",
    "franchiseList": [
      {
        "cos": true,
        "franchiseNumber": 2,
        "franchiseKey": 3,
        "isTestFranchise": true,
        "routeId": "sample string 5"
      },
      {
        "cos": true,
        "franchiseNumber": 2,
        "franchiseKey": 3,
        "isTestFranchise": true,
        "routeId": "sample string 5"
      }
    ],
    "lastName": "sample string 4",
    "userKey": 1,
    "cas": 5,
    "cw": "2025-06-06T19:32:44.2145375-04:00",
    "id": "sample string 7"
  }
}

Resource Description

UserTokenModel

Name	Description	Type	Additional information
token		string	None.
expire		date	None.
isSyncGatewayEnabled		boolean	None.
message	Error Message	string	None.
userChannel		string	None.
userDetailsAsw		CacheUserAsw	None.

Response Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "expire": "2025-06-06T19:32:44.2145375-04:00",
  "isSyncGatewayEnabled": true,
  "message": "",
  "userChannel": null,
  "userDetailsAsw": {
    "deleted": true,
    "dealerList": [
      {
        "dealerLotKey": 1,
        "dealerName": "sample string 2",
        "franchiseKey": 3,
        "isTestDealer": true
      },
      {
        "dealerLotKey": 1,
        "dealerName": "sample string 2",
        "franchiseKey": 3,
        "isTestDealer": true
      }
    ],
    "emailId": "sample string 2",
    "firstName": "sample string 3",
    "franchiseList": [
      {
        "cos": true,
        "franchiseNumber": 2,
        "franchiseKey": 3,
        "isTestFranchise": true,
        "routeId": "sample string 5"
      },
      {
        "cos": true,
        "franchiseNumber": 2,
        "franchiseKey": 3,
        "isTestFranchise": true,
        "routeId": "sample string 5"
      }
    ],
    "lastName": "sample string 4",
    "userKey": 1,
    "cas": 5,
    "cw": "2025-06-06T19:32:44.2145375-04:00",
    "id": "sample string 7"
  }
}