Object Exit Service RESTful APIs

Owned by Jesse Martinez
Dec 20, 2013
2 min read
Object Exit Service Home

Brief Description

Error rendering macro 'excerpt-include' : No link could be created for 'Object Exit Service Description and Assumptions'.
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.

REST-based API

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

Object Exit CRUD+L services

Create an Object Exit

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

POST /cspace-services/objectexit HTTP/1.1
Read an Object Exit

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

GET /cspace-services/objectexit/{id} HTTP/1.1
Update an Object Exit

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

PUT /cspace-services/objectexit/{id} HTTP/1.1
Delete an Object Exit

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

DELETE /cspace-services/objectexit/{id} HTTP/1.1
List Object Exit instances

Lists existing Object Exit records, with summary information for each. Follows standard List model. See the documentation of the Object Exit list schema, below. Example:

GET /cspace-services/objectexit/ HTTP/1.1

Verify whether the Object Exit service supports pagination of list results, and if so, add relevant documentation here regarding same.

Object Exit REST payload schemas

Object Exit instance schema

Create and Update should use the following schema:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:objectexit_common
xmlns:ns2="http://collectionspace.org/services/objectexit"
xmlns:ns3="http://collectionspace.org/services/jaxb">
  <depositor>urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Northern Climes Museum)'Northern Climes Museum'</depositor>
  <exitNumber>objectexitNumber-1290026472360</exitNumber>
</ns2:objectexit_common>

Read will return the following schema:

<?xml version="1.0" encoding="UTF-8"?>
<ns2:objectexit_common xmlns:ns2="http://collectionspace.org/services/objectexit" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://collectionspace.org/services/objectexit http://services.collectionspace.org/objectexit/objectexit_common.xsd">
<exitMethods/>
<exitNumber>objectexitNumber-1290026472360</exitNumber>
<depositor>urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Northern Climes Museum)'Northern Climes Museum'</depositor>
</ns2:objectexit_common>
Object Exit list schema

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:objectexit_common_list
xmlns:ns2="http://collectionspace.org/services/jaxb"
xmlns:ns3="http://collectionspace.org/services/objectexit">
  <pageNum>0</pageNum>
  <pageSize>40</pageSize>
  <itemsInPage>1</itemsInPage>
  <totalItems>1</totalItems>
  <fieldsReturned>exitNumber|currentOwner|uri|csid</fieldsReturned>
  <objectexit_list_item>
    <exitNumber>objectexitNumber-1290026472360</exitNumber>
    <uri>/objectexit/98d61417-3986-4de6-bb98</uri>
    <csid>98d61417-3986-4de6-bb98</csid>
  </objectexit_list_item>
</ns3:objectexit_common_list>