Skip to content
Accquix Register
Esc
↑↓navigate↵open⌘Jpreview

Data freshness per source

GET/v1/sources
Authorization
AuthorizationBearer token · headerrequired
Responses
200

OK

attributionstring[] | nullrequired
bootstrappingbooleanrequired

true until every source is first published

demobooleanrequired

true on a demo database: fictional subjects, not register data (accquix-register demo)

licencesobjectrequired
setupPendingbooleanrequired

true until the operator confirms the objections of this installation; the data endpoints answer 503 reason=setup

sourcesSourceInfo[] | nullrequired
Show properties
Array of SourceInfo
diagnosticstring
maxAgeDaysinteger<int64>required
publishedAsOfstring

Date the published data was stamped by the agency

skippedItemsinteger<int64>

Items of the published file left out: no identifier at all, or (in the DIČ list) an IČO without a DIČ yet. More than 100 blocks the list

sourcestringrequired
stalebooleanrequired
statestringrequired
Allowed:emptybootstrapdailygap_waitreconcileblocked
401

Unauthorized

codestringrequired

Stable error code: invalid_request, invalid_identifier, unauthorized, forbidden, not_found, rate_limited, fuzzy_disabled, unavailable, internal

detailstring

Explanation specific to this occurrence

errorsErrorDetail[] | null

Validation details

Show properties
Array of ErrorDetail
locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

reasonstring

For unavailable: bootstrapping, setup, source_stale, timeout, database, overloaded

statusinteger<int64>required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

A URI reference for the problem type

500

Internal Server Error

codestringrequired

Stable error code: invalid_request, invalid_identifier, unauthorized, forbidden, not_found, rate_limited, fuzzy_disabled, unavailable, internal

detailstring

Explanation specific to this occurrence

errorsErrorDetail[] | null

Validation details

Show properties
Array of ErrorDetail
locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

reasonstring

For unavailable: bootstrapping, setup, source_stale, timeout, database, overloaded

statusinteger<int64>required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

A URI reference for the problem type

503

Service Unavailable

codestringrequired

Stable error code: invalid_request, invalid_identifier, unauthorized, forbidden, not_found, rate_limited, fuzzy_disabled, unavailable, internal

detailstring

Explanation specific to this occurrence

errorsErrorDetail[] | null

Validation details

Show properties
Array of ErrorDetail
locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

reasonstring

For unavailable: bootstrapping, setup, source_stale, timeout, database, overloaded

statusinteger<int64>required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

A URI reference for the problem type

Request
curl -X GET 'http://localhost:8080/v1/sources' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "attribution": [
    "string"
  ],
  "bootstrapping": true,
  "demo": true,
  "licences": {
    "property1": "string",
    "property2": "string"
  },
  "setupPending": true,
  "sources": [
    {
      "diagnostic": "string",
      "maxAgeDays": 0,
      "publishedAsOf": "string",
      "skippedItems": 0,
      "source": "string",
      "stale": true,
      "state": "empty"
    }
  ]
}