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 AWS or with isCGDProtected as true through the API.
It is also not possible to update the Customer Code through Submit Collection process.
Records that have already been deaccessioned cannot be updated or modified through the Submit Collection process.

Request Query - Submit Collection Records
/sharedCollection/submitCollection

Query Parameters

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 the subsequent matching algorithm will happen.

Request - Submit Collection Records (SCSB XML)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibRecords>
    <bibRecord>
        <bib>
            <owningInstitutionId>Institutionname</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>

Request - Submit Collection Records (MARC XML)

<?xml version="1.0"?>
<collection xmlns="http://www.loc.gov/MARC21/slim" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd">
<record>
    <leader>00855cam a2200253 a 4500</leader>
    <controlfield tag="001">175157</controlfield>
    <controlfield tag="005">20160518221807.0</controlfield>
    <controlfield tag="008">830914s1982 gw b 00010 ger d</controlfield>
    <datafield ind1=" " ind2=" " tag="020">
        <subfield code="a">3877395317</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="035">
        <subfield code="a">(OCoLC)74575525</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="035">
        <subfield code="a">(CStRLIN)NJPG83-B61980</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="035">
        <subfield code="9">AAZ0042TS</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="040">
        <subfield code="a">NjP</subfield>
        <subfield code="c">NjP</subfield>
    </datafield>
    <datafield ind1="1" ind2=" " tag="100">
        <subfield code="a">Rottmann, Johannes H.</subfield>
    </datafield>
    <datafield ind1="1" ind2="0" tag="245">
        <subfield code="a">-und werden den Lehren der Da&#x308;monen anhangen /</subfield>
        <subfield code="c">Johannes H. Rottmann.</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="250">
        <subfield code="a">1. Aufl.</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="260">
        <subfield code="a">Asslar :</subfield>
        <subfield code="b">Schulte und Gerth,</subfield>
        <subfield code="c">1982.</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="300">
        <subfield code="a">127 p. ;</subfield>
        <subfield code="c">20 cm.</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="504">
        <subfield code="a">Bibliography: p. 124-127.</subfield>
    </datafield>
    <datafield ind1=" " ind2="0" tag="650">
        <subfield code="a">Demonology.</subfield>
        <subfield code="0">
            (uri)http://id.loc.gov/authorities/subjects/sh85036663
        </subfield>
    </datafield>
    <datafield ind1=" " ind2="0" tag="650">
        <subfield code="a">God.</subfield>
        <subfield code="0">
            (uri)http://id.loc.gov/authorities/subjects/sh85055517
        </subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="998">
        <subfield code="a">04/02/86</subfield>
        <subfield code="s">9118</subfield>
        <subfield code="n">NjP</subfield>
        <subfield code="w">NJPG83B61980</subfield>
        <subfield code="d">09/14/83</subfield>
        <subfield code="c">GMA</subfield>
        <subfield code="b">MT</subfield>
        <subfield code="i">860402</subfield>
        <subfield code="l">NJPG</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="911">
        <subfield code="a">19921028</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="912">
        <subfield code="a">19900821000000.0</subfield>
    </datafield>
    <datafield ind1=" " ind2=" " tag="959">
        <subfield code="a">2000-06-13 00:00:00 -0400</subfield>
    </datafield>
    <datafield ind1="0" ind2="0" tag="852">
        <subfield code="0">193086</subfield>
        <subfield code="b">rcppa</subfield>
        <subfield code="h">BT975 .R67</subfield>
        <subfield code="t">1</subfield>
        <subfield code="x">tr fr f</subfield>
    </datafield>
    <datafield ind1="0" ind2="0" tag="876">
        <subfield code="0">193086</subfield>
        <subfield code="a">187267</subfield>
        <subfield code="h"/>
        <subfield code="j">Not Charged</subfield>
        <subfield code="p">32101079749824</subfield>
        <subfield code="t">1</subfield>
        <subfield code="x">Shared</subfield>
        <subfield code="z">PA</subfield>
    </datafield>
</record>
</collection>

Response - Submit Collection Records

[
  {
    "itemBarcode": "32101075649143",
    "message": "SuccessRecord"				//	Successfully edited
  },
  {
    "itemBarcode": "32101075649143",
    "message": "RejectionRecord"			//	Rejected
  },
  {
    "itemBarcode": "32101075649168",
    "message": "RejectionRecord"
  },
  {
    "itemBarcode": "32101075649176",
    "message": "RejectionRecord"
  },
  {
    "itemBarcode": "32101075649184",
    "message": "RejectionRecord"
  }
]

Alternate Response - Submit Collection Records

[
  {
    "itemBarcode": null,
    "message": "Invalid SCSB xml format"	//	Invalid SCSBXML format
  }
]

Alternate Response - Submit Collection Records

[
  {
    "itemBarcode": null,
    "message": "Invalid Marc xml format"	//	Invalid MARCXML format
  }
]

Alternate Response - Submit Collection Records

[
  {
    "itemBarcode": "4324234234234324",
    "message": "ExceptionRecord"			//	Exception record
  }
]

Alternate Response - Submit Collection Records

[
  {
    "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 for Availability status and Customer Code, everything else can be updated through the Submit Collection API. However, when the item is out (Not available in 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.