The response which contains the XML content can either be returned as HTML or through FTP. This is configured through the request parameter, transmissionType. A cap of 100 records is set for HTML response. Anything above this cap or if the parameter is left empty then the result is transmitted as FTP. The location where the XML files are uploaded in the FTP is configured in the application-<environment>.properties file. The file is found under scsb-etl/src/main/resources/ folder.
Usually, the FTP location is /share/storagelocation/data-dump/<environment>/<partnercode>/<outputformat>. So for example, if someone is looking for a file generated for an Institution (requestingInstitutionCode input parameter) in tst environment with MarcXML as the output format, then the FTP location is /share/storagelocation/data-dump/tst/Institution/MarcXml
Parameters
Parameter | Data Type | Description |
|---|---|---|
| institutionCodes | String | Institution code(s) of the partner(s) whose shared or open item information updates are being requested. Use PUL for Princeton, CUL for Columbia and NYPL for New York Public Library. Two institution codes can be simultaneously requested by separating the codes with a comma (,) without any space between. For example, to request for Princeton and Columbia records, use PUL,CUL as the value. |
| requestingInstitutionCode | String | Institution code of the partner who is requesting for the shared or open item information updates. Use PUL for Princeton, CUL for Columbia and NYPL for New York Public Library. |
| fetchType | String | There are two types of export - Incremental and Deleted. Incremental would bring those records that have been incrementally added (through Ongoing Accession) to SCSB. Deleted would bring those records that have been removed (through Deaccession) from SCSB and those records that earlier had an Open or Shared Collection Group Designation (CGD) but have been moved to Private. Use 1 to choose Incremental and 2 to choose Deleted. |
| outputFormat | String | SCSB allows exporting of records in two different formats - MARCXML and SCSBXML (more details here). Deleted record information is always exported in the JSON format. The values in this parameter allows the user to select the format type. Use 0 for MARCXML, 1 for SCSBXML and 2 for the JSON format. |
| date | String | Date and Time mentioned here is considered and only those data that were added, removed or modified are retrieved and exported as part of the export process. The format followed is YYYY-MM-DD HH:MM. For example, to consider data from 1:00 PM, 09th of June 2017, use 2017-06-09 13:00 |
| toDate | String | Date and Time mentioned here is considered and only those data that were added, removed or modified until the date and time are retrieved and exported as part of the export process. The format followed is YYYY-MM-DD HH:MM. For example, to consider data till 1:00 PM, 09th of August 2017, use 2017-08-09 13:00 |
| collectionGroupIds | String | User can choose to export only those records with CGD as Shared or Open using this parameter. Use 1 to export records with Shared CGD, 2 to export records with Open CGD. Leaving this parameter empty without any value considers both Shared and Open CGD records for export. |
| transmissionType | String | Transmission is either through HTTP (show as part of response) or through FTP (export and save files to a FTP location configured in SCSB). There is a limit of 100 records to show as part of the HTTP transmission type. Requests that return more than a 100 records are exported through FTP automatically. Use 0 for FTP transmission type and 1for HTTP transmission type. Leaving this parameter empty without any value considers the transmission type as FTP. |
| emailToAddress | String | Email address to whom an email will be sent upon completion of the export process. |
Response
Input Parameters | Response | |
|---|---|---|
| With incremental fetch type, output format as MARCXML and transmission type as HTTP | MARCXML as defined here. | |
| With incremental fetch type, output format as SCSBXML and transmission type as HTTP | SCSBXML as defined here. | |
| With incremental fetch type, output format as JSON (deaccessioned items and those that were moved from shared and open CGD to private) and transmission type as HTTP | [
{
"bibId":"5",
"itemBarcodes":[
"32101075649143"
]
},
{
"bibId":"786782",
"itemBarcodes":[
"32101075852192"
]
},
{
"bibId":"786787",
"itemBarcodes":[
"32101075852226"
]
}
]
| |
| With incremental fetch type and transmission type as HTTP with more than 100 records expected in response |
| |
| With incremental fetch type and transmission type as FTP |
| |
| Transmission type as FTP with date and email address empty |
|