Archives

Search archives

get

Returns up to limit archives whose label, alt label, or city matches query (case-insensitive substring). When query is omitted, returns archives ordered by label.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

limitintegerOptional

Maximum rows to return (clamped between 1 and 100, default 10).

querystringOptional

Case-insensitive substring filter on label, alt label, or city.

Responses

200Success

application/json

get/api/archives/

GET /api/archives/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "alt_label": "text",
      "description": "text",
      "country": "text",
      "country_subdivision": "text",
      "city": "text",
      "url": "text",
      "uri": "text",
      "parent_institution": {
        "id": 1,
        "institution_type": "text",
        "label": "text",
        "alt_label": "text",
        "description": "text",
        "country": "text",
        "country_subdivision": "text",
        "city": "text",
        "ror": "text",
        "parent_institutions": "text",
        "can_edit": "text",
        "created_by": 1
      }
    }
  ]
}

Create archive

post

Creates a new archive record for sample registration and batch defaults.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

labelstring · max: 200Required

alt_labelstring · max: 200 · nullableOptional

descriptionstring · nullableOptional

countrystring · nullableOptional

country_subdivisionstring · max: 255 · nullableOptional

citystring · max: 255 · nullableOptional

urlstring · max: 200 · nullableOptional

uristring · max: 36 · nullableOptional

parent_institutioninteger · nullableOptional

created_byinteger · nullableRead-onlyRequired

Responses

201Success

application/json

post/api/archives/

POST /api/archives/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "label": "text",
  "alt_label": "text",
  "description": "text",
  "country": "text",
  "country_subdivision": "text",
  "city": "text",
  "url": "text",
  "uri": "text",
  "parent_institution": 1
}

201Success

{
  "data": {
    "id": 1,
    "label": "text",
    "alt_label": "text",
    "description": "text",
    "country": "text",
    "country_subdivision": "text",
    "city": "text",
    "url": "text",
    "uri": "text",
    "parent_institution": {
      "id": 1,
      "institution_type": "text",
      "label": "text",
      "alt_label": "text",
      "description": "text",
      "country": "text",
      "country_subdivision": "text",
      "city": "text",
      "ror": "text",
      "parent_institutions": "text",
      "can_edit": "text",
      "created_by": 1
    }
  }
}