ErrorResponseConfig

The ErrorResponseConfig REST API endpoint enables you to define and manage custom SIP error responses—including status codes, status texts, and additional headers—that are returned when admission control or resource thresholds are breached in Priority Call Handling.

URL Syntax

For a GET:

/management/weblogic/latest/serverConfig/customResources/prioritycallconfig/customResource/priorityErrorResponseConfig

For a POST:

/management/weblogic/latest/edit/customResources/prioritycallconfig/customResource/priorityErrorResponseConfig

HTTP Methods

  • GET
  • POST

Parameters

Table 17-21 URL Parameters for the customResource endpoint

Names Description
links Set to none if you want to remove the links from the response. Set to an enumerated list of the links to return. For example:
.../customResource/priorityErrorResponseConfig?links=none

Examples

Example 17-62 Get information for all Error Response Configs

curl -u 'weblogic:<password>' \
    "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/prioritycallconfig/customResource/priorityErrorResponseConfig?links=none"

Example response:

{
  "items": [
    {
      "identity": [
        "customResources",
        "prioritycallconfig",
        "customResource",
        "priorityErrorResponseConfig",
        "wlss.threshold.violation.callrate.protection"
      ],
      "statusText": "Service Unavailable",
      "errorId": "wlss.threshold.violation.callrate.protection",
      "additionalHeaderList": [],
      "statusCode": 503
    },
    {
      "identity": [
        "customResources",
        "prioritycallconfig",
        "customResource",
        "priorityErrorResponseConfig",
        "wlss.priority.call.violation.queue.maximum.wait.timeout"
      ],
      "statusText": "Request Timeout - Message In Queue",
      "errorId": "wlss.priority.call.violation.queue.maximum.wait.timeout",
      "additionalHeaderList": [],
      "statusCode": 408
    },
    {
      "identity": [
        "customResources",
        "prioritycallconfig",
        "customResource",
        "priorityErrorResponseConfig",
        "wlss.priority.call.violation.rph.namespace.value.unknown"
      ],
      "statusText": "Unknown Resource-Priority",
      "errorId": "wlss.priority.call.violation.rph.namespace.value.unknown",
      "additionalHeaderList": [],
      "statusCode": 417
    }
  ]
}

Example 17-63 Get information for a single Error Response Config

curl -u 'weblogic:<password>' \
    "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/prioritycallconfig/customResource/priorityErrorResponseConfig/wlss.threshold.violation.callrate.protection?links=none"

Expected response:

{
  "identity": [
    "customResources",
    "prioritycallconfig",
    "customResource",
    "priorityErrorResponseConfig",
    "wlss.threshold.violation.callrate.protection"
  ],
  "statusText": "Service Unavailable",
  "errorId": "wlss.threshold.violation.callrate.protection",
  "additionalHeaderList": [],
  "statusCode": 503
}

Example 17-64 Update information for a single Error Response Config

curl -X POST --user weblogic:<password> \
  -H "X-Requested-By: MyClient" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"statusText":"This Service is not available"}' \
  "http://10.0.0.1:7001/management/weblogic/latest/edit/customResources/prioritycallconfig/customResource/priorityErrorResponseConfig/wlss.threshold.violation.callrate.protection"