Archival description management

API endpoints for viewing, creation, updating and deleting posts in ESSArchs ARchival description management functionality.

Agents 

API endpoint that allows authority records (Agents) to be viewed or edited.

GET /api/agents/

http

GET /api/agents/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agents/ -H "Accept: application/json" --user admin:admin

Agent Type 

API endpoint that allows agent types to be viewed or edited

GET /api/agent-types/

http

GET /api/agent-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agent-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/agent-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/agent-types/

http

POST /api/agent-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X POST https://localhost/api/agent-types/ -H "Accept: application/json" --user admin:admin

response

POST /api/agent-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

Agent Identifier Type 

API endpoint that allows agent identifier types to be viewed or edited

GET /api/agent-identifier-types/

http

GET /api/agent-identifier-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agent-identifier-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/agent-identifier-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/agent-identifier-types/

Agent Name Types 

API endpoint that allows agent name types to be viewed or edited

GET /api/agent-name-types/

http

GET /api/agent-name-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agent-name-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/agent-name-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/agent-name-types/

Agent Note Types 

API endpoint that allows agent note types to be viewed or edited

GET /api/agent-note-types/

http

GET /api/agent-note-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agent-note-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/agent-note-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/agent-note-types/

Agent Place Type 

API endpoint that allows Agent place types to be viewed or edited.

GET /api/agent-place-types/

http

GET /api/agent-place-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agent-place-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/agent-place-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/agent-place-types/

Agent Relation Types 

API endpoint that allows agent relation types to be viewed or edited

GET /api/agent-relation-types/

http

GET /api/agent-relation-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/agent-relation-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/agent-relation-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/agent-relation-types/

Authority Types 

API endpoint that allows authority types to be viewed or edited

GET /api/authority-types/

http

GET /api/authority-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/authority-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/authority-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/authority-types/

Deliveries 

API endpoint that allows deliveries to be viewed or edited

GET /api/deliveries/

http

GET /api/deliveries/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/deliveries/ -H "Accept: application/json" --user admin:admin

response

GET /api/deliveries/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/deliveries/

Delivery Types 

API endpoint that allows delivery types to be viewed or edited

GET /api/delivery-types/

http

GET /api/delivery-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/delivery-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/delivery-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/delivery-types/

Location 

API endpoint that allows locations to be viewed or edited

GET /api/locations/

http

GET /api/locations/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/locations/ -H "Accept: application/json" --user admin:admin

response

GET /api/locations/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/locations/

Location Level Type 

API endpoint that allows location level types to be viewed or edited

GET /api/location-level-types/

http

GET /api/location-level-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/location-level-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/location-level-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/location-level-types/

Location Function Type 

API endpoint that allows location function types to be viewed or edited

GET /api/location-function-types/

http

GET /api/location-function-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/location-function-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/location-function-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/location-function-types/

Language 

API endpoint that allows language types to be viewed or edited

GET /api/languages/

http

GET /api/languages/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/languages/ -H "Accept: application/json" --user admin:admin

response

GET /api/languages/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/languages/

Metric Type 

API endpoint that allows metric types to be viewed or edited

GET /api/metric-types/

http

GET /api/metric-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/metric-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/metric-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/metric-types/

Node Relation Type 

API endpoint that allows node relation types to be viewed or edited

GET /api/node-relation-types/

http

GET /api/node-relation-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/node-relation-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/node-relation-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/node-relation-types/

Node Note Type 

API endpoint that allows node note types to be viewed or edited

GET /api/node-note-types/

http

GET /api/node-note-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/node-note-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/node-note-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/node-note-types/

Node Identifier Type 

API endpoint that allows node identifier types to be viewed or edited

GET /api/node-identifier-types/

http

GET /api/node-identifier-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/node-identifier-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/node-identifier-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/node-identifier-types/

Structures 

API endpoint that allows structures to be viewed or edited

GET /api/structures/

http

GET /api/structures/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/structures/ -H "Accept: application/json" --user admin:admin

response

GET /api/structures/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/structures/

Structure Units 

API endpoint that allows structure units to be viewed or edited

GET /api/structure-units/

http

GET /api/structure-units/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/structure-units/ -H "Accept: application/json" --user admin:admin

response

GET /api/structure-units/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/structure-units/

Structure Type 

API endpoint that allows structure types to be viewed or edited

GET /api/structure-types/

http

GET /api/structure-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/structure-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/structure-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/structure-types/

Parameters:

name – Name of the structure type
instance_name – Named to be used on instances of a structure
editable_instances – true/false
movable_instance_units – true/false
editable_instance_relations – true/false

Status Codes:

201 Created – Created

Tag 

API endpoint that allows tags to be viewed or edited

GET /api/tags/

http

GET /api/tags/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/tags/ -H "Accept: application/json" --user admin:admin

response

GET /api/tags/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/tags/

POST /api/tag-version-types/

Creates a new tag. Tags are either top-level resources or nodes referenced in a structure instance.

Status Codes:

201 Created – Created

Tag Version Type 

API endpoint that allows tag version types to be viewed or edited

GET /api/tag-version-types/

http

GET /api/tag-version-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/tag-version-types/ -H "Accept: application/json" --user admin:admin

response

GET /api/tag-version-types/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/tag-version-types/

Creates a new tag version type

Parameters:

name – Name or title of the tag version type
archive_type – true if type is to be an archive type
information_package_type – true if type is to be a information package type

Status Codes:

201 Created – Created

Ref Code 

API endpoint that allows ref codes to be viewed or edited

GET /api/ref-codes/

http

GET /api/ref-codes/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/ref-codes/ -H "Accept: application/json" --user admin:admin

response

GET /api/ref-codes/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/ref-codes/

Creates a new ref code

Parameters:

country – The id of a country
repository_code – A repository code

Status Codes:

201 Created – Created

Transfers 

API endpoint that allows transfers to be viewed or edited

GET /api/transfers/

http

GET /api/transfers/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

curl

curl -i -X GET https://localhost/api/transfers/ -H "Accept: application/json" --user admin:admin

response

GET /api/transfers/ HTTP/1.1
Host: localhost
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=

POST /api/transfers/

creates a new transfer

Parameters:

name – The transfers name
delivery – Id of the delivery in Deliveries
submitter_organization – The organization responsible for the transfer.
submitter_organization_main_address – The address to the organization responsible for the transfer.
submitter_individual_name – The named individual responsible for the transfer
submitter_individual_email – The email to the individual responsible for the transfer
description – A description of the transfer e.g. what is being transferred

Status Codes:

201 Created – Created