Versions Compared

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

...

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:

...

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:

...

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:

...

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

...

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. Acquisition supports the following common parameters for List results, pagination controls and query filters:

  • pgSz for page size
  • pgNum for page size

Examples:

...

Example:

Code Block
GET /cspace-services/acquisitions/ HTTP/1.1
GET /cspace-services/acquisitions/?pgSz=10 HTTP/1.1
GET /cspace-services/acquisitions/?pgSz=10&pgNum=3 HTTP/1.1
GET /cspace-services/acquisitions/?pgNum=3 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

...

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>
  </acquisitionSources>
  <acquisitionReason>Supplement collection of board games.</acquisitionReason>
  ...
</ns2:acquisitions-common>
Note

More complete examples of these schemas will be added here in the near future.

Acquisition 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:

...