CanonicalReference — JSON-LD

GET

/id/ref/{uuid}.json

const url = 'https://textrefs.org/id/ref/example.json';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://textrefs.org/id/ref/example.json

Parameters

Path Parameters

uuid

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

Responses

200

CanonicalReference record as JSON-LD.

application/json

object

status

required

string

Allowed values: draft active deprecated withdrawn blocked

created

required

string

/^\d{4}-\d{2}-\d{2}$/

modified

required

string

/^\d{4}-\d{2}-\d{2}$/

superseded_by

Successor IRI. Only present when status is deprecated, withdrawn, or blocked.

string format: iri

required

string

/^https://textrefs\.org/id/ref/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

type

required

string

Allowed values: CanonicalReference

work_key

required

Flat registry key: lowercase, starts with [a-z0-9], allows . _ -

string

/^[a-z0-9][a-z0-9._-]*$/

citation_system_key

required

Flat registry key: lowercase, starts with [a-z0-9], allows . _ -

string

/^[a-z0-9][a-z0-9._-]*$/

locator

required

string

>= 1 characters

resolver_targets

required

Array<object>

default:

object

url

required

An IRI (RFC 3987), not a URI (RFC 3986). The registry publishes resolver targets that carry non-ASCII characters, such as …/Investigaciones_filosóficas_(edición_A). RFC 3986 forbids those characters, so a validator that enforces the uri format rejects records this site serves. The generated JSON Schema declares iri for the same reason.

string format: iri

language

string

>= 2 characters /^(?:[A-Za-z]{2,3}(?:-[A-Za-z]{3}){0,3}|[A-Za-z]{4,8})(?:-[A-Za-z]{4})?(?:-(?:[A-Za-z]{2}|\d{3}))?(?:-(?:[\dA-Za-z]{5,8}|\d[\dA-Za-z]{3}))*(?:-[\dA-WY-Za-wy-z](?:-[\dA-Za-z]{2,8})+)*(?:-[Xx](?:-[\dA-Za-z]{1,8})+)?$|^[Xx](?:-[\dA-Za-z]{1,8})+$/

edition

string

provider

string

access

required

string

Allowed values: open paywalled restricted unknown

license

string

license_url

One of:

string
null

string format: iri

last_checked

string

/^\d{4}-\d{2}-\d{2}$/

Example

{
  "status": "draft",
  "type": "CanonicalReference",
  "resolver_targets": []
}

404

No registry object found at this identifier. The site is static, so the host cannot build a per-path error body. It serves the site’s own 404 page instead: text/html, with the same navigation as every other page. A client detects the miss from the status code, not from the body.

text/html

The site’s HTML 404 page.

string