DQM Checkpoint API

The DQM Checkpoint API calls provide information relating to the Checkpoints that are configured within your DQM instance.

GET accessibility website overview
https://api.crownpeak.net/dqm-checkpoint/v1/accessibility/websites/:websiteID/overview?clientId=5678&visibility=public

Returns an overview of Checkpoints that are configured for the specified Website.

 

AUTHORIZATION Bearer Token

 

HEADERS

---

Authorization

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c Bearer token from DQM-security

 

PARAMS

---

clientId

5678

The required client ID for the website.

 

visibility

public

One of either: public|restricted

 

PATH VARIABLES

---

websiteID

1234

The required website ID of which you want overview data.

 

---

Example Request

curl --location --request GET 'https://api.crownpeak.net/dqm-checkpoint/v1/accessibility/websites/1234/overview?clientId=5678&visibility=public' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

Example Response (body)

{
  "checkpoints": [
    {
      "id": "xxxxxxx",
      "name": "Do not use fonts other than arial",
      "reference": "0.2",
      "totalIssues": 19,
      "priority": false,
      "visibility": "public",
      "successCriteria": []
    },
    {
      "id": "xxxxxxx",
      "name": "Always write the company name correctly",
      "reference": "0.4",
      "totalIssues": 6,
      "priority": false,
      "visibility": "public",
      "successCriteria": []
    },
    {
      "id": "xxxxxxx",
      "name": "Do not use underlining to highlight text",
      "reference": "1.1",
      "totalIssues": 7,
      "priority": false,
      "visibility": "public",
      "successCriteria": []
    },
    {
      "id": "xxxxxxx",
      "name": "Do not use italic <i> tags to emphasize text",
      "reference": "1.3",
      "totalIssues": 0,
      "priority": false,
      "visibility": "public",
      "successCriteria": [
        {
          "id": "xxxxxxx",
          "principle": "Perceivable",
          "guideline": "Adaptable",
          "referenceId": "1.3.1",
          "standards": [
            "WCAG2"
          ],
          "wcagLevel": "A",
          "name": "Info and Relationships",
          "url": "https://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html",
          "techniques": [
            {
              "name": "H49",
              "url": "https://www.w3.org/TR/2016/NOTE-WCAG20-TECHS-20161007/H49"
            }
          ]
        }
      ]
    }
  ]
}

Example Response (Headers)

Access-Control-Allow-Origin: *
Connection: keep-alive
Content-Length: 31588
Content-Type: application/json
Date: Fri, 08 Jun 2018 13:31:40 GMT
Via: 1.1 09716b2b6b7791e009b0ae423d8e6e44.cloudfront.net (CloudFront)
X-Amz-Cf-Id: EcWPXBcdk1GRFQiBtCBm3OwWIqsUy7K8GEiPBN7c6-xvFGpjQS5ipg==
X-Amzn-Trace-Id: Root=1-5b1a853c-ab30db3c93b6b538d2c7d9b8
X-Cache: Miss from cloudfront
x-amz-apigw-id: IKnBbG42DoEFVDg=
x-amzn-RequestId: 46ae8d8b-6b20-11e8-8ae1-bd7048460475