CanonicalReference — JSON-LD

GET

/id/ref/{uuid}.json

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

• Production

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.

Media type application/json

object

status

required

string

Allowed values: candidate active deprecated withdrawn blocked

created

required

string

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

modified

required

string

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

id

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

normalization_version

required

string

/^\d+\.\d+\.\d+(?:-[\w.-]+)?(?:\+[\w.-]+)?$/

resolver_targets

required

Array<object>

default:

object

url

required

string format: uri

language

string

>= 2 characters

edition

string

provider

string

access

required

string

Allowed values: open paywalled restricted unknown

license

string

license_url

One of:

string

string format: uri

null

null

last_checked

string

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

Example

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

404

No registry object found at this identifier.

Media type application/json

object

message

required

string

code

string

Example ^generated

{
  "message": "example",
  "code": "example"
}