Brief Description

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.

References

Object Entry Requirements
Acquisition Stories
Acquisition Service Description and Assumptions
Acquisition Service Entity Diagrams
Acquisition Schema

REST-based API

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

• Acquisition CRUD+L services
• Acquisition REST payload schemas

Acquisition CRUD+L services

Create an Acquisition

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

POST /cspace-services/acquisitions HTTP/1.1

Read an Acquisition

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

GET /cspace-services/acquisitions/{id} HTTP/1.1

Update an Acquisition

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

PUT /cspace-services/acquisitions/{id} HTTP/1.1

Delete an Acquisition

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

DELETE /cspace-services/acquisitions/{id} HTTP/1.1

List Acquisition instances

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

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

• pgSz for page size
• pgNum for page size

Examples:

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

Acquisition REST payload schemas

Acquisition instance schema

Create and Update should use the following schema.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:acquisitions_common xmlns:ns2="http://collectionspace.org/services/acquisition">
  <acquisitionReferenceNumber>2010.1.51</acquisitionReferenceNumber>
  <acquisitionSources>
    <acquisitionSource>Milton Bradley</acquisitionSource>
  </acquisitionSources>
  <acquisitionReason>Supplement collection of board games.</acquisitionReason>
</ns2:acquisitions-common>

Read will return the above, plus additional fields (uri and csid) for access:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:acquisitions_common xmlns:ns2="http://collectionspace.org/services/acquisition" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://collectionspace.org/services/acquisition http://services.collectionspace.org/acquisition/acquisitions_common.xsd">
  ...
  <uri>/acquisitions/f0cf4c50-8f8a-4df0-869a</uri>
  <csid>f0cf4c50-8f8a-4df0-869a</csid>
</ns2:acquisitions-common>

Acquisition schema

List (and variants) will return the following schema.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:acquisitions-common-list xmlns:ns2="http://collectionspace.org/services/acquisition">
  <acquisition-list-item>
    <acquisitionReferenceNumber>2010.1.51</acquisitionReferenceNumber>
    <uri>/acquisitions/c6563617-a129-4b92-8d38</uri>
    <csid>c6563617-a129-4b92-8d38</csid>
  </acquisition-list-item>
  ....
</ns2:acquisitions-common-list>