22.4.1.2 Response JSON Parameters

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

Table 22-11 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 setting the preferences

  • false
  • true

Table 22-12 Possible Status Codes

Status Code Description
Success:200 Success
Error:400 Invalid inputs
Error:500 Internal Server error

Response JSON Sample


Success response - Status code: 200
{
    "message": "Updated email notifications for devsuser successfully.",
    "status": true
}
Status code: 400
        {
            "message": " Provide either user or userGroup. ",
            "status": false
        }
        
        {
            "message": "ProcessId or PackageId not provided!",
            "status": false
        }
        
        {
            "message": "isEmailRequired Flag not present",
            "status": false
        }
        
        {
            "message": "Please provide isEmailRequired value as Y/N only.",
            "status": false
        }
        
        {
            "message": "Please provide isEmailRequiredForCompletedStatus value as Y/N only.",
            "status": false
        }
        
        {
            "message": "Please provide isEmailRequiredForFailedStatus value as Y/N only.",
            "status": false
        }
        
        {
            "message": "Invalid package Id or process Id.",
            "status": false
        }
        
        {
            "message": "Provide either user or userGroup.",
            "status": false
        }

Status code: 404

{
    "message": "Couldn't find the registration to update! ",
    "status": false
}

Status code: 500

{
  "message": "Internal Server Error!",
  "status": false
}


Status code: 401

   {
        "message": "Not privileged user",
        "status": false
    }