ApiResponseEntityGetAuthorizationRestrictionOverrides

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-api-response-entity-get-authorization-restriction-overrides-schema.json",
  "title": "ApiResponseEntityGetAuthorizationRestrictionOverrides",
  "description": "Response to: List the Authorization Restriction Overrides",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-account-authorization-restriction-api-openapi.yml#/components/schemas/ApiResponseEntityGetAuthorizationRestrictionOverrides",
  "type": "object",
  "required": [
    "responseMetadata"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AuthorizationRestrictionOverride"
      }
    },
    "responseMetadata": {
      "allOf": [
        {
          "$ref": "#/$defs/ResponseMetadata"
        }
      ]
    }
  },
  "$defs": {
    "AuthorizationRestrictionIdentifier": {
      "type": "object",
      "properties": {
        "authorizationRestrictionReference": {
          "type": "string",
          "description": "minLength: 1\nmaxLength: 60\nIdentifies the restriction."
        }
      },
      "title": "AuthorizationRestrictionIdentifier"
    },
    "AuthorizationRestrictionOverride": {
      "type": "object",
      "properties": {
        "activationEndTime": {
          "type": "string",
          "description": "Last point in time at which the override will be considered. Has to be later than ActivationStartTime. Can be present without ActivationStartTime. If not provided the override will be taken into account forever."
        },
        "activationStartTime": {
          "type": "string",
          "description": "First point in time at which the override will be considered. Has to be before ActivationEndTime. Can be present without ActivationEndTime. If not provided the override will be taken into account immediately."
        },
        "authorizationRestrictionOverrideIdentifier": {
          "$ref": "#/$defs/AuthorizationRestrictionOverrideIdentifier"
        },
        "conditionCheck": {
          "type": "boolean",
          "description": "Overrides the default configured for the corresponding restriction attribute (see configuration entity explanations). In case JSON null is provided then the default becomes effective."
        },
        "conditionParameters": {
          "type": "array",
          "description": "Overrides the default configured for the corresponding restriction attribute. An item must not have leading or trailing spaces. Moreover it must not contain any comma. In case JSON null is provided then the default becomes effective.",
          "items": {
            "type": "string"
          }
        },
        "defaultAuthorizationRestrictionReference": {
          "$ref": "#/$defs/AuthorizationRestrictionIdentifier"
        },
        "deleted": {
          "type": "boolean",
          "description": "Indicates whether the override is still present or has been deleted."
        },
        "issuerId": {
          "type": "string",
          "description": "Not used, will be removed."
        },
        "priority": {
          "type": "string",
          "description": "minimum: 0\nmaximum: 9999\nIn case multiple overrides with overlapping activation times are existing this information is used to resolve this situation by applying the overrides one by one starting with the one with lowest priority. The priority needs to be unique across all overrides associated with a restriction and an account. Required field when inserting."
        }
      },
      "title": "AuthorizationRestrictionOverride"
    },
    "AuthorizationRestrictionOverrideIdentifier": {
      "type": "object",
      "properties": {
        "authorizationRestrictionOverrideReference": {
          "type": "string",
          "description": "minLength: 1\nmaxLength: 100\nIdentifies the restriction override which has to be replaced. Can be absent when inserting. In such a case, WLP FO will generate the reference."
        }
      },
      "title": "AuthorizationRestrictionOverrideIdentifier"
    },
    "Links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "type": "string",
          "description": "Service method URL"
        },
        "next": {
          "type": "string",
          "description": "URL pagination query parameter next page"
        }
      },
      "title": "Links"
    },
    "ResponseMetadata": {
      "type": "object",
      "required": [
        "correlationId",
        "responseDateTime",
        "statusCode",
        "statusMessage"
      ],
      "properties": {
        "correlationId": {
          "type": "string",
          "description": "Correlation Identifier"
        },
        "links": {
          "description": "Metadata Links",
          "allOf": [
            {
              "$ref": "#/$defs/Links"
            }
          ]
        },
        "statusMessage": {
          "type": "string",
          "description": "Executed REST API status message"
        },
        "statusCode": {
          "type": "integer",
          "format": "int32",
          "description": "HTTP status code"
        },
        "responseDateTime": {
          "type": "string",
          "description": "Timestamp when response date was generated"
        },
        "timeTakenMs": {
          "type": "integer",
          "format": "int64",
          "description": "Wall clock time required from service to generate the response"
        }
      },
      "title": "ResponseMetadata"
    }
  }
}