Request Format
All request parameters as application/json parameters. Header parameters are mandatory in all requests.
Response Format
Responses from the API will be in JSON.
Successful Response
{
"status": “SUCCESS”,
"message”: “SUCCESS”,
"errorcode":"",
"data":{}
}
Failed Response
{
"status”: “FAILURE",
"message”: “Login Id/Password Is Invalid",
"errorcode":"MOSL100",
"data”: “null"
}
The status field in the response contains the value SUCCESS/FAILURE. Message field contains actual description of the error. The errorcode field contains the error-code mentioned in Error Codes and Description section.
Header Parameters
| Parameter | Value | Description |
|---|---|---|
| Accept | application/json | application/json |
| User-Agent: | MOSL/V.1.1.0 | Product and Its Version |
| Authorization | 774aac4a0a8846cc865d7df05c095b13_M | Used in all API’s excluding login API. |
| ApiKey | bxga2zcjpqa5u542peag | Api Key of App |
| ClientLocalIp | 1.2.3.4 | System Local IP Address |
| ClientPublicIp | 1.2.3.4 | Public IP Address |
| MacAddress | 00:00:00:00:00:00 | System Mac Address |
| SourceId | WEB | WEB|MOBILE|DESKTOP |
| vendorinfo | T0240 | For client pass client code and for vendor pass vendor short name |
| osname | Windows 10 | Operating System name |
| osversion | 10.0.19041 | Operating System version |
| devicemodel | AHV | Device Model |
| manufacturer | DELL | Device Manufacturer |
| productname | Your Product Name | Your Product Name |
| productversion | Your Product Version | Your Product Version |
| installedappid | AppID | Mandatory for DESKTOP|MOBILE |
| imeino | 15 Digit IMEI No. | Mandatory for MOBILE |
| browsername | Chrome | Mandatory for WEB |
| browserversion | 105.0 | Mandatory for WEB |