CitationSystem — JSON-LD

GET

/id/system/{key}.json

const url = 'https://textrefs.org/id/system/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/system/example.json

Parameters

Path Parameters

key

required

string

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

Flat registry key.

Responses

200

CitationSystem 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/system/[^/]+$/

key

required

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

string

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

type

required

string

Allowed values: CitationSystem

preferred_label

required

string

>= 1 characters

description

required

string

>= 1 characters

locator_regex

required

string

>= 1 characters

Example

{
  "status": "draft",
  "type": "CitationSystem"
}

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