Versions Compared

Version Old Version 2 New Version Current
Changes made by

Aron Roberts (Unlicensed)

Aron Roberts (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Div
stylefont-weight:bold;font-size:1.2em;
Acquisition Service Home

Brief Description

Insert excerpt
SDRcollectionspace:Acquisition Service Description and AssumptionsSDR
collectionspace:Acquisition Service Description and Assumptions
namebrief-description
nopaneltrue
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

Create an Acquisition

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

Code Block
POST /cspace-services/acquisitions HTTP/1.1
Read an Acquisition

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

Code Block
GET /cspace-services/acquisitions/{id} HTTP/1.1
Update an Acquisition

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

Code Block
PUT /cspace-services/acquisitions/{id} HTTP/1.1
Delete an Acquisition

Deletes an existing Acquisition record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:

Code Block
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 list schema, below.

Note

Aron to verify pagination support in Acquisition service

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

  • pgSz for page size
  • pgNum for page size

ExamplesExample:

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

The Acquisition service does not currently support pagination; restore wording from version 5 of this document when that support is added.

Acquisition REST payload schemas

Acquisition 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 Acquisition records, please see the Acquisition 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:acquisitions_common xmlns:ns2="http://collectionspace.org/services/acquisition">
  <acquisitionReferenceNumber>2010.1.51<1</acquisitionReferenceNumber>
  <acquisitionSources>
    <acquisitionSource>Milton Bradley<<acquisitionSource>urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Hasbro, Inc.)'Hasbro, Inc.'</acquisitionSource>
  </acquisitionSources>
  <acquisitionReason>Supplement collection of board games.</acquisitionReason>
  ...
</ns2:acquisitions-common>

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

Code Block
<?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">
  <acquisitionReferenceNumber>2010.1</acquisitionReferenceNumber>
  <acquisitionSources>
    <acquisitionSource>urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Hasbro, Inc.)'Hasbro, Inc.'</acquisitionSource>
  <uri>/acquisitions/f0cf4c50-8f8a-4df0-869a</uri>
  <csid>f0cf4c50-8f8a-4df0-869a</csid></acquisitionSources>
  <acquisitionReason>Supplement collection of board games.</acquisitionReason>
  ...
</ns2:acquisitions-common>
Acquisition 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:

Code Block
<?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>