22.1.1.2 Response JSON Parameters

This section provides the list of parameters in the JSON Response.

Table 22-3 POST JSON Response

Name Type Description
message STRING

Details of the error/success.

statusCode STRING It indicates the status code of the service.
status STRING

Status of the registration:

  • false
  • true

Table 22-4 Possible Status Codes

Status Code Description
Success:200 Success
Error:400 Invalid inputs
Error:401 Not privileged user
Error:500 Internal Server error

Response JSON Sample

Unauthorized user - Status code : 401 
    {
        "message": "Not privileged user",
        "status": false
    }
Process Id or user and user group both are  missing in requset body : Status code : 400 
    {
        "message": "Email registration failed : Process Id or user/usergroup details not passed",
        "status": false
    }
Process Id is not valid - Status code : 400 
    {
        "message": "Email registration failed : Invalid process Id",
        "status": false
    }
Invalid user passed in request - Status code : 400 
    {
    "message": "Email registration failed : Invalid users [appuser12, dummyuser12]",
    "status": false
    }   
Invalid user group passed in request - Status code : 400 
    {
    "message": "Email registration failed : Invalid user group DEV",
    "status": false
    }
User or user group is already registerd for email notification for given process - Status code : 400 
            user: {
                        "message": "Email registration failed : user [appuser, dummyuser] registered already ",
                        "status": false
                  }
        userGroup:  {
                        "message": "Email registration failed : usergroup  [IDNTY_ADMN] registered already ",
                        "status": false
                    }
Server side exception - Status code : 500 
    {
    "message": "Internal server error ",
    "status": false
    }
Success response - Status code : 200
{
"message": "Email is registered successfully!",
"status": true
 }