Getting an error page¶

Sends a GET request to the endpoint /domain/{domainId}/errorpages/{id}.

Description¶

The Get-Error-Page request allows the user to request a single error page for a specified ID.

Requirements¶

Values of the request: Domain-ID {domainId}, Error-Page-ID {id}

Objects: none

Request¶

To request an error page, the Domain-ID {domainId} and the Error-Page-ID {id} need to be added to the path of the request.

As a result, the user gets an object ErrorPageVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`subDomainName`	The name of the subdomain the error page belongs to.	`string`
`errorCode`	The error code the error page is shown for. The value `9999` represents blocked requests.	`400` `404` `405` `429` `500` `502` `503` `504` `9999`
`content`	The HTML content of the error page.	`string`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

{
  "objectType": "string",
  "subDomainName": "string",
  "errorCode": 0,
  "content": "string",
  "id": 0,
  "modified": "string",
  "created": "string"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.