Versions Compared

Key

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

...

  • pgSz for page size
  • pgNum for page size

Examples:

Code Block

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

CollectionObject REST payload schemas

...

Create and Update should use the following schema:

...

Code Block
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:collectionobjects-common xmlns:ns2="http://services.collectionspace.org/collectionobject">
    <objectNumber>2010.5.18</objectNumber>
    <objectName>Laguna Tide Pool</objectName>
    <title>Impressionist Painting</title>
    ...
</ns2:collectionobjects-common>

...

Code Block
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:collectionobjects_common xmlns:ns2="http://collectionspace.org/services/collectionobject" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://collectionspace.org/services/collectionobject http://services.collectionspace.org/collectionobject/collectionobjects_common.xsd">
    <objectNumber>2010.5.18</objectNumber>
    <objectName>Laguna Tide Pool</objectName>
    <title>Impressionist Painting</title>
    ...
</ns2:collectionobjects-common>
Note
More complete examples of these schemas will be added here in the near future.
CollectionObject list 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:

...