Status Codes

The GetFTR API supports response and entitleement-level status codes. Response status codes are standard HTTP status codes, while entitlement status codes indicate the status for a particular entitlement within a larger response.

Consider the following response:

{
  "entitlements": [
    {
      "doi": "10.10/does.not-exist",
      "statusCode": 404
    },
    {
      "doi": "10.10/4512",
      "statusCode": 504
    },
    {
      "doi": "10.10/1234",
      "statusCode": 200,
      "entitled": "yes",
      "accessType": "paid",
      "source": "service_request",
      "document": "https://link-to-content-on-your-platform.com",
      "org": {
        "ipv4": "1.2.3.4"
      },
      "vor": [
        {
          "contentType": "application/pdf",
          "url": "https://link-to-content-on-your-platform.com"
        }
      ],
      "av": [],
      "updates": []
    }
  ]
}

• The response status code is 200, as the request has been handled successfully.
• The first entitltment object has a status code of 404, indicating that the DOI 10.10/does.not-exist has not been found at the Publisher.
• The second entitlement object has a status code of 504, indicating that the check timed out.

Response Status Codes

Response status codes should be as per the HTTP Specification. The following status codes are supported:

Entitlement Status Codes