All | Crest

All

Crest can perform multiple tests in a single API call. It checks WCAG violations on a webpage and provides XPaths/CSS selectors of the violated elements. It currently supports the following functionalities and their detailed information can be found on their documentation page.

Request

URI

POST

https://{api_host}/http://{server-ip}:{port}//crest/api/all

COPY

Request Body

request_body of type(s) application/json

Required

{
    "url": "string",
    "reporttype": 0
}

string

url

Required

A URL to check WCAG violations on. It should be a valid URL.

integer

reporttype

Optional

reporttype is either xpath(value: 3) or css selector(value: 4)

Responses

200

The Success response contains categories that aggregate all the Error and Alert related issues.

Returns crest_success_response of type(s) application/json

{
    "categories": {
        "alert": {
            "count": 0,
            "description": "string",
            "items": {
                "cr_heading_unrelated": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string",
                    "xpaths": []
                }
            }
        },
        "error": {
            "count": 0,
            "description": "string",
            "items": {
                "cr_focus_low": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string",
                    "xpaths": []
                },
                "cr_focus_missing": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string",
                    "xpaths": []
                },
                "cr_captions_missing": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string"
                },
                "cr_transcript_missing": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string"
                }
            }
        }
    },
    "statistics": {
        "allitemcount": 0,
        "pageurl": "string",
        "time": "number",
        "totalelements": 0,
        "totalaudios": 0,
        "totalvideos": 0
    },
    "status": {
        "httpstatuscode": 0,
        "success": "string"
    }
}

crest_categories