| Div | ||
|---|---|---|
| ||
| Intake Service Home |
Brief Description
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
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. Example:
| Note |
|---|
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:
| Code Block |
|---|
| Code Block |
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:
| Code Block |
|---|
GET /cspace-services/intakes/?pgSz=10 HTTP/1.1 |
List also supports query parameters for searching for matching records, including keyword search. For example:
| Code Block |
|---|
GET /cspace-services/intakes/?kw=foo&pgSz=10 HTTP/1.1 |
Intake REST payload schemas
Intake instance schema
| Info |
|---|
The schemas below are severely abbreviated, and are thus illustrative. For a full list of the fields that may potentially be present in payloads when creating, updating, or reading individual Intake records, please see the Intake record schema for release 0.5. |
Create and Update should use the following schema.
| Note |
|---|
Aron to verify that this simpler, single namespace attribute works for create and update, and to replace with more full declaration if it does not |
:
| Code Block |
|---|
<?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>EV2010<entryNumber>IN2010.2</entryNumber> <depositor>Alfred<depositor>urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Alfred L. Kroeber)'Alfred L. Kroeber<Kroeber'</depositor> ... </ns2:intakes-_common> |
Read will return the following schema:
| Code Block |
|---|
<?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>EV2010<entryNumber>IN2010.2</entryNumber>
<depositor>Alfred<depositor>urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Alfred L. Kroeber)'Alfred L. Kroeber<Kroeber'</depositor>
...
</ns2:intakes-_common>
|
| Note |
Intake
...
schema
...
| Note |
|---|
More complete examples of these schemas will be added here in the near future. |
Intake schema
List (and variants) will return the following schema. This schema includes the additional fields uri and csid fields to help facilitate access to individual records:
| Code Block |
|---|
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:intakes-common-list xmlns:ns2="http://collectionspace.org/services/intake">
<intake-list-item>
<entryNumber>EV2010<entryNumber>IN2010.2</entryNumber>
<depositor>Alfred L. Kroeber</depositor>
<uri>/intakes/b59d0c6f-08f2-4fb5-b5f7</uri>
<csid>b59d0c6f-08f2-4fb5-b5f7</csid>
</intake-list-item>
....
</ns2:intakes-common-list>
|