Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Note

Aron to verify pagination support in Intake service

...

  • pgSz for page size
  • pgNum for page size

Examples:

Code Block

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

Intake REST payload schemas

...

Create and Update should use the following schema:

...

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://services.collectionspace.org/intake">
    <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>

...

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>IN2010.2</entryNumber>
    <depositor>urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Alfred L. Kroeber)'Alfred L. Kroeber'</depositor>
    ...
</ns2:intakes-common>
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:

...