User login Verification
This API user for to check the user is active or Inactive
POSThttps://yourdomain.comwebservice?token=getLoginStatus
Request Parameters
| Parameter | Type | Value | Description |
|---|---|---|---|
| auth-code | String | header token | It is Mandatory and we have to pass Generated token in header of the request |
Description
Method Name
getLoginStatus
Prerequisites
Before calling this API we need to call generateAccessToken API in order to generate the token.
Request
| Request Format | json |
{
"username" : "XXXX" ,
"password" : "XXXX",
}
Response
Key | Format | Mandatory | Description |
| data | json | yes | Contains User Status and login details |
| data.logindetails | json | yes | contains user login details |
data.logindetails.username | String | yes | contain username |
data.logindetails.password | String | yes | contain password |
data.status | Json | yes | contain user status and code |
data.status.code | string | yes | contain user status HTTP code(200,401,403 ) |
root.status.message | String | yes | show status user active or inactive |
Error Code | Status |
0 | Fail |
1 | Success |
Sample Response
Sucesss{
"result": 1,
"data": {
"logindetails": {
"password": "111",
"username": "111"
},
"status": {
"code": "200",
"message": " active"
}
},
"message": "User is Active"
}
Fail
{
"result": 0,
"data": {
"logindetails": {
"password": "111",
"username": "filter"
},
"status": {
"code": "403",
"message": " Inative"
}
},
"message": "Current user is inactive "
}
fail
{
"result": 0,
"data": {
"logindetails": {
"password": "",
"username": ""
},
"status": {
"code": "401",
"message": "invalid Credntail "
}
},
"message": "Bad Login AND Password"
}
Fail
{
"result": 0,
"message": "Invalid Creadentail"
}
Fail
{
"result": 0,
"message": "Invalid Request Payload"
}
Fail
{
"result": 0,
"message": "Invalid Token genrated"
}
Fail
{
"result": 0,
"message": "Refresh Token Expired "
}
Response codes
| Code | Description |
|---|
Error codes
| Code | Name | Description |
|---|