Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Intake Service Home

Brief Description

For a full description, visit the Service Description and Assumptions page.

Assumptions

For a complete list of assumptions, visit the Service Description and Assumptions page.

References

Object Entry Requirements
Intake Stories
Intake Service Description and Assumptions
Intake Service Entity Diagrams
Intake Schema

REST-based API

The Intake Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Intake instances, plus list operations on multiple Intake instances. These follow the Common model for CollectionSpace REST services.

Intake CRUD+L services

Create an Intake

Creates a new Intake record. Assigns a unique, service-specified CollectionSpace ID (CSID) to that Intake record. Follows standard Create model. See the documentation of the Intake schema, below. Example:

POST /cspace-services/intakes HTTP/1.1
Read an Intake

Reads an existing Intake record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the Intake schema, below. Example:

GET /cspace-services/intakes/{id} HTTP/1.1
Update an Intake

Updates an existing Intake record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the Intake schema, below. Example:

PUT /cspace-services/intakes/{id} HTTP/1.1
Delete an Intake

Deletes an existing Intake record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:

DELETE /cspace-services/intakes/{id} HTTP/1.1
List Intake instances

Lists existing Intake records, with summary information for each. Follows standard List model, with pagination support. See the documentation of the Intake schema, below.

Aron to verify pagination support in Intake service

Intake supports the following common parameters for List results, pagination controls and query filters:

  • pgSz for page size
  • pgNum for page size

Examples:

GET /cspace-services/intakes/ HTTP/1.1
GET /cspace-services/intakes/?pgSz=10 HTTP/1.1

Intake REST payload schemas

Intake instance schema

Create and Update should use the following schema.

Aron to update with Intake instance schema used in payloads to create and update

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:orgauthorities-common xmlns:ns2="http://services.collectionspace.org/organization">
  <displayName>Museum Internal</displayName>
  <refName>urn:cspace:org.collectionspace.demo:orgauthority:name(Museum Internal)'Museum Internal'</refName>
  <vocabType>OrgAuthority</vocabType>
</ns2:orgauthorities-common>

Read will return the above, plus additional fields (uri and csid) for access:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:intakes-common xmlns:ns2="http://services.collectionspace.org/intake">
  ...
  <uri>/intakes/f0cf4c50-8f8a-4df0-869a</uri>
  <csid>f0cf4c50-8f8a-4df0-869a</csid>
</ns2:intakes-common>
Intake schema

List (and variants) will return the following schema.

Aron to update with Intake list schema

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:orgauthorities-common-list xmlns:ns2="http://services.collectionspace.org/organization">
  <pageNum>0</pageNum>
  <pageSize>40</pageSize>
  <totalItems>3</totalItems>
  <orgauthorities_list_item>
    <displayName>Museum Internal</displayName>
    <refName>urn:cspace:org.collectionspace.demo:orgauthority:name(Museum Internal)'Museum Internal'</refName>
    <vocabType>OrgAuthority</vocabType>
    <uri>/orgauthorities/f0cf4c50-8f8a-4df0-869a</uri>
    <csid>f0cf4c50-8f8a-4df0-869a</csid>
  </orgauthorities_list_item>
  ...
</ns2:orgauthorities-common-list>
  • No labels