22.3.1.1 Response JSON Parameters

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

Table 22-8 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 fetching the list.

  • false
  • true

Table 22-9 Possible Status Codes

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

Response JSON Sample

Success Response - Status Code : 200
{
    "emailList": [
        {
            "isEmailRequired": "Y",
            "packageId": "100",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y",
            "user": "devvuser"
        },
        {
            "isEmailRequired": "Y",
            "packageId": "100",
            "usergroup": "dev",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y"
        },
        {
            "isEmailRequired": "Y",
            "packageId": "100",
            "usergroup": "qa",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y"
        },
        {
            "isEmailRequired": "N",
            "processId": "1701260707779",
            "processName": "test_email",
            "packageId": "100",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y",
            "user": "devsuser"
        },
        {
            "isEmailRequired": "Y",
            "processId": "1701260707779",
            "processName": "test_email",
            "packageId": "100",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y",
            "user": "devnuser"
        },
        {
            "isEmailRequired": "Y",
            "processId": "1701260707779",
            "processName": "test_email",
            "packageId": "100",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y",
            "user": "appuser"
        },
        {
            "isEmailRequired": "Y",
            "processId": "1701260707779",
            "processName": "test_email",
            "packageId": "100",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y",
            "user": "dummyuser"
        },
        {
            "isEmailRequired": "Y",
            "processId": "1701260707779",
            "processName": "test_email",
            "packageId": "100",
            "usergroup": "IDNTY_ADMN",
            "isEmailRequiredForFailedStatus": "Y",
            "packageName": "Platform",
            "isEmailRequiredForCompletedStatus": "Y"
        }
    ]
}

Status Code : 400
{
            "message": "Can't have request parameters as empty.",
            "status": false
        }
        {
            "message": "Request validation failed to presence of blacklisted characters",
            "status": false
        }
        {
            "message": "Can't have request parameters as empty.",
            "status": false
        }
Status Code : 500

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

Status Code : 401

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

Status Code : 404
{
    "message": "Not Found!",
    "status": false
}