Submit Collection API is a REST service where users can provide MARC content in either SCSB XML or MARC XML formats and update the underlying record in SCSB. Sample XML content data can be found below.
Submit Collection process doesn't update Collection Group Designation (CGD) while the data is uploaded in the cgd_protection folder in FTP or with isCGDProtected is CGD Protected as true through the API. It is also not possible to update Customer Code through Submit Collection process. Also records that have already been deaccessioned cannot be updated or modified through the Submit Collection process.
...
| Parameter | Data Type | Description |
|---|---|---|
| institution | String | Valid values are PUL, CUL, HL and NYPL |
| isCGDProtected | Boolean | Valid values are true and false. If true is selected, the record's CGD is not updated in SCSB. if false is selected, no protection is accorded to the CGD and it will be updated and subsequent matching algorithm will happen. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"itemBarcode": "4324234234234324",
"message": "ExceptionRecord" // Exception record
}
] |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[ { "itemBarcode": "4324234234234324", "message": "Exception record - Item not updated, it is a deaccessioned item" // When a deaccessioned item is being updated through the Submit Collection API. } ] |
Bulk Upload
Information on bulk upload of files for submit collection is available here.
Constraints on what can be edited
Except Availability status and Customer Code everything else can be updated through the Submit Collection API. However, when the item is out (Not available in ReCAPa Storage Location), the Collection Group Designation (CGD) and Use Restriction cannot be updated. There is a limit on the number of records that can be edited through the API in a single call. It is currently set at 100 and is configured in the external properties file under external.submit.collection.input.limit. Items that have been deaccessioned cannot be edited through Submit Collection.