Appearance
validateWallPasscode ​
Validates a "wall-secured" MI company by checking the passcode provided by the client app.
Request ​
http
POST /rest/company/validate/wallHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
A JSON request in format below. All fields mandatory. Only version 1 supported as of 2016-09-29.
| Parameter | Type | Required | Description |
|---|---|---|---|
cId | Yes | Company id of secured MI company | |
passcode | Yes | The passcode as set for the security-enabled company |
json
{
"version": 1,
"passcode": "some passcode",
"cId": 1
}Response ​
200 OK ​
HTTP Response differs depending on: 1.) Whether the company is secured or not 2.) Whether the supplied passcode is correct or not.
CASE 1: security enabled and supplied passcode correct
json
{
"valid": true,
"timeoutMins": 30
}json
{
"valid": false
}json
{
"valid": true,
"timeoutMins": null
}Errors ​
| Exception | Description |
|---|---|
WSInvalidParameterException | See Error Definitions |
WSUnsupportedVersionException | See Error Definitions |
WSInvalidAuthTokenException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSCompanyServiceException | See Error Definitions |
WSInternalException | See Error Definitions |