Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 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.

Code Block
languagexml
titleRequest - Submit Collection Records (SCSB XML)
linenumberstrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibRecords>
    <bibRecord>
        <bib>
            <owningInstitutionId>PUL</owningInstitutionId>
            <owningInstitutionBibId>22</owningInstitutionBibId>
            <content>
                <collection>
                    <record>
                        <leader>00885cas a2200289 i 4500</leader>
                        <controlfield tag="001">SCSB-5</controlfield>
                        <controlfield tag="005">20160317172955.0</controlfield>
                        <controlfield tag="008">801201d197219uururar p       0uuuc0rusr </controlfield>
                        <datafield ind1=" " ind2=" " tag="010">
                            <subfield code="a">   72357714  </subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="035">
                            <subfield code="a">(OCoLC)5062456</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="035">
                            <subfield code="a">(CStRLIN)NJPG0127-S</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="035">
                            <subfield code="9">AAF4256TS</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="040">
                            <subfield code="a">NjP</subfield>
                            <subfield code="c">NjP</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="043">
                            <subfield code="a">e-ur---</subfield>
                        </datafield>
                        <datafield ind1="0" ind2=" " tag="050">
                            <subfield code="a">UA772</subfield>
                            <subfield code="b">.S82</subfield>
                        </datafield>
                        <datafield ind1="1" ind2=" " tag="212">
                            <subfield code="a">Sto voprosov- sto otvetov</subfield>
                        </datafield>
                        <datafield ind1="0" ind2="0" tag="245">
                            <subfield code="a">10000 voprosov - 100 otvetov.</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="260">
                            <subfield code="a">Moskva :</subfield>
                            <subfield code="b">Mol. Gvardii︠a︡,</subfield>
                            <subfield code="c">1972-</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="300">
                            <subfield code="a">v. :</subfield>
                            <subfield code="b">ill. ;</subfield>
                            <subfield code="c">26-41 cm.</subfield>
                        </datafield>
                        <datafield ind1="0" ind2=" " tag="362">
                            <subfield code="a">1972-</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="500">
                            <subfield code="a">Cover title.</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="515">
                            <subfield code="a">Vols. for 1972-&lt;1982&gt; called also vyp. 1-&lt;8/2&gt;.</subfield>
                        </datafield>
                        <datafield ind1=" " ind2="0" tag="651">
                            <subfield code="a">Soviet Union</subfield>
                            <subfield code="x">Armed forces.</subfield>
                            <subfield code="0">(uri)http://id.loc.gov/authorities/subjects/sh85125707</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="998">
                            <subfield code="a">06/29/94</subfield>
                            <subfield code="s">9114</subfield>
                            <subfield code="n">NjP</subfield>
                            <subfield code="w">NJPG0127S</subfield>
                            <subfield code="d">10/05/81</subfield>
                            <subfield code="c">APG</subfield>
                            <subfield code="b">DPK</subfield>
                            <subfield code="i">940629</subfield>
                            <subfield code="l">NJPG</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="948">
                            <subfield code="a">AACR2 CONV.</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="911">
                            <subfield code="a">19940708</subfield>
                        </datafield>
                        <datafield ind1=" " ind2=" " tag="912">
                            <subfield code="a">19940629000000.0</subfield>
                        </datafield>
                    </record>
                </collection>
            </content>
        </bib>
        <holdings>
            <holding>
                <owningInstitutionHoldingsId>23</owningInstitutionHoldingsId>
                <content>
                    <collection>
                        <record>
                            <datafield ind1="0" ind2="1" tag="852">
                                <subfield code="b">rcppa</subfield>
                                <subfield code="h">UA772.S82</subfield>
                            </datafield>
                            <datafield ind1=" " ind2="0" tag="866">
                                <subfield code="6">0</subfield>
                                <subfield code="x">OK to add by imprint year per DLJ 6-18-87</subfield>
                            </datafield>
                        </record>
                    </collection>
                </content>
                <items>
                    <content>
                        <collection>
                            <record>
                                <datafield ind1=" " ind2=" " tag="876">
                                    <subfield code="p">32101075649143</subfield>
                                    <subfield code="h"/>
                                    <subfield code="a">5591314</subfield>
                                    <subfield code="j">Available</subfield>
                                    <subfield code="t">1</subfield>
                                    <subfield code="3">1979 (vyp.7) </subfield>
                                </datafield>
                                <datafield ind1=" " ind2=" " tag="900">
                                    <subfield code="a">Shared</subfield>
                                    <subfield code="b">PA</subfield>
                                </datafield>
                            </record>
                            <record>
                                <datafield ind1=" " ind2=" " tag="876">
                                    <subfield code="p">32101075649150</subfield>
                                    <subfield code="h"/>
                                    <subfield code="a">5591315</subfield>
                                    <subfield code="j">Available</subfield>
                                    <subfield code="t">1</subfield>
                                    <subfield code="3">1981 (vyp.8) </subfield>
                                </datafield>
                                <datafield ind1=" " ind2=" " tag="900">
                                    <subfield code="a">Shared</subfield>
                                    <subfield code="b">PA</subfield>
                                </datafield>
                            </record>
                            <record>
                                <datafield ind1=" " ind2=" " tag="876">
                                    <subfield code="p">32101075649168</subfield>
                                    <subfield code="h"/>
                                    <subfield code="a">5591317</subfield>
                                    <subfield code="j">Not Available</subfield>
                                    <subfield code="t">1</subfield>
                                    <subfield code="3">1982 (vyp.8/2) </subfield>
                                </datafield>
                                <datafield ind1=" " ind2=" " tag="900">
                                    <subfield code="a">Shared</subfield>
                                    <subfield code="b">PA</subfield>
                                </datafield>
                            </record>
                            <record>
                                <datafield ind1=" " ind2=" " tag="876">
                                    <subfield code="p">32101075649176</subfield>
                                    <subfield code="h"/>
                                    <subfield code="a">5591320</subfield>
                                    <subfield code="j">Not Available</subfield>
                                    <subfield code="t">1</subfield>
                                    <subfield code="3">1985 </subfield>
                                </datafield>
                                <datafield ind1=" " ind2=" " tag="900">
                                    <subfield code="a">Shared</subfield>
                                    <subfield code="b">PA</subfield>
                                </datafield>
                            </record>
                            <record>
                                <datafield ind1=" " ind2=" " tag="876">
                                    <subfield code="p">32101075649184</subfield>
                                    <subfield code="h"/>
                                    <subfield code="a">5591324</subfield>
                                    <subfield code="j">Not Available</subfield>
                                    <subfield code="t">1</subfield>
                                    <subfield code="3">1986 </subfield>
                                </datafield>
                                <datafield ind1=" " ind2=" " tag="900">
                                    <subfield code="a">Shared</subfield>
                                    <subfield code="b">PA</subfield>
                                </datafield>
                            </record>
                        </collection>
                    </content>
                </items>
            </holding>
        </holdings>
    </bibRecord>
</bibRecords>

...

ParameterData TypeDescription
institutionStringValid values are PUL, CUL, HL and NYPL
isCGDProtectedBooleanValid 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
titleResponse - Submit Collection Records
linenumberstrue
[
  {
    "itemBarcode": "32101075649143",
    "message": "SuccessRecord"				//	Successfully edited
  },
  {
    "itemBarcode": "32101075649143",
    "message": "RejectionRecord"			//	Rejected
  },
  {
    "itemBarcode": "32101075649168",
    "message": "RejectionRecord"
  },
  {
    "itemBarcode": "32101075649176",
    "message": "RejectionRecord"
  },
  {
    "itemBarcode": "32101075649184",
    "message": "RejectionRecord"
  }
]


Code Block
languagejs
titleAlternate Response - Submit Collection Records
linenumberstrue
[
  {
    "itemBarcode": null,
    "message": "Invalid SCSB xml "RejectionRecord"format"	//	Invalid SCSBXML format
  }
]


Code Block
languagejs
titleAlternate Response - Submit Collection Records
linenumberstrue
[
  {
    "itemBarcode": null,
    "message": "Invalid SCSBMarc xml format"	//	Invalid SCSBXMLMARCXML format
  }
]


Code Block
languagejs
titleAlternate Response - Submit Collection Records
linenumberstrue
[
  {
    "itemBarcode": null"4324234234234324",
    "message": "Invalid Marc xml format"	ExceptionRecord"			//	InvalidException MARCXMLrecord
format   }
]


Code Block
languagejs
titleAlternate Response - Submit Collection Records
linenumberstrue
[
  {
    "itemBarcode": "4324234234234324",
    "message": "ExceptionRecord"			//	Exception recordException 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.