{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Table of Contents","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"style":{"value":"disc"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"61238332-bf9b-4488-b70b-6e3bac86513a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c4d3f7d6-82a9-4778-af33-6fd7dc6cffa8"}}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"About Loan Out Service RESTful APIs","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The Loan Out Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Loan Out instances, plus list operations on multiple Loan Out instances. ","type":"text"}]},{"type":"paragraph","content":[{"text":"These follow the ","type":"text"},{"text":"Common model for CollectionSpace REST services","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3577544705"}}]},{"text":".","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Loan Out CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create an Loan Out","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new Loan Out record. Assigns a unique, service-specified ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":" to that Loan Out record. Follows standard Create model. See the documentation of the Loan Out schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"15aafde9-b2f5-4ade-8140-9a86c83f9f41"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/loansout HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read an Loan Out","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing Loan Out record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Read model. See the documentation of the Loan Out schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"4ccd556a-0a4f-4f50-aedf-9b8128b31e23"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/loansout/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update an Loan Out","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing Loan Out record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Update model. See the documentation of the Loan Out schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"235cccc5-2f47-4c4e-ae3f-635cd6a6363b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/loansout/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete an Loan Out","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing Loan Out record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"a5ef7dc7-4e47-4e71-a3d5-fb2841817029"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/loansout/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List Loan Out instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing Loan Out records, with summary information for each. Follows standard List model. See the documentation of the Loan Out list schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"3065b220-c763-4f1c-b185-631338b06b43"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/loansout HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"6327f107-32d1-4772-b4f2-bcbdb13670aa"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/loansout?pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List also supports query parameters for searching for matching records, including keyword search. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"80096b9c-68ab-4f35-9057-5f1fdd2c40ff"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/loansout?kw=foo&pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Loan Out REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Loan Out instance schema","type":"text"}]},{"type":"paragraph","content":[{"text":"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 Loan Out records, please see ","type":"text"},{"text":"the Loan Out record schema for release 0.5.2","type":"text","marks":[{"type":"link","attrs":{"href":"http://fisheye.collectionspace.org/browse/~raw,r=1819/collectionspace/src/services/trunk/services/loanout/jaxb/src/main/resources/loansout-common.xsd"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"5fa374f6-f249-4315-8f3e-c6fad020a278"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" LO2010.117","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Northern Climes Museum)'Northern Climes Museum'\")","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Chris Contact)'Chris Contact'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-29","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Allow people in cold climes to share the magic of Surfboards of the 1960s, via planned exhibition beginning 2 March 2011.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Read will return the following schema:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"d65030cf-3439-4542-b2da-8de8b453627e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" LO2010.117","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:orgauthority:name(TestOrgAuth):organization:name(Northern Climes Museum)'Northern Climes Museum'\")","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:personauthority:name(TestPersonAuth):person:name(Chris Contact)'Chris Contact'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-29","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Allow people in cold climes to share the magic of Surfboards of the 1960s, via planned exhibition beginning 2 March 2011.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Loan Out list schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return the following schema. This schema includes the ","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":" fields to help facilitate access to individual records:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"26023b92-f2ca-4a01-a386-ce098a6dfd87"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" LO2010.117","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-29","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /loansout/b59d0c6f-08f2-4fb5-b5f7","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" b59d0c6f-08f2-4fb5-b5f7","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ....","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"rule"}],"version":1}

Browser not supported