CitationSystem — JSON-LD

GET

/id/system/{key}.json

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

• Production

Parameters

Path Parameters

key

required

string

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

Flat registry key.

Responses

200

CitationSystem 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/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

normalization_version

required

string

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

locator_regex

required

string

>= 1 characters

examples

required

object

valid

required

Array<string>

>= 1 items

invalid

required

Array<string>

>= 1 items

Example

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

404

No registry object found at this identifier.

Media type application/json

object

message

required

string

code

string

Example ^generated

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