Brief Description

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

...

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

...

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

...

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

...

Deletes an existing Intake record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:

...

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

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

• pgSz for page size
• pgNum for page size

ExamplesExample:

GET /cspace-services/intakes/ HTTP/1.1

List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:

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

List also supports query parameters for searching for matching records, including keyword search. For example:

GET /cspace-services/intakes/?kw=foo&pgSz=10&pgNum=3 HTTP/1.1
GET /cspace-services/intakes/?pgNum=3 HTTP/1.1

Intake REST payload schemas

...

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:intakes-_common xmlns:ns2="http://collectionspace.org/services/intake" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://collectionspace.org/services/intake http://services.collectionspace.org/intake/intakes_common.xsd">
    <entryNumber>IN2010.2</entryNumber>
    <depositor>urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Alfred L. Kroeber)'Alfred L. Kroeber'</depositor>
    ...
</ns2:intakes-_common>

Read will return the following schema:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:intakes_common xmlns:ns2="http://collectionspace.org/services/intake" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://collectionspace.org/services/intake http://services.collectionspace.org/intake/intakes_common.xsd">
    <entryNumber>IN2010.2</entryNumber>
    <depositor>urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Alfred L. Kroeber)'Alfred L. Kroeber'</depositor>
    ...
</ns2:intakes-_common>

Intake schema

List (and variants) will return the following schema. This schema includes the uri and csid fields to help facilitate access to individual records:

...