Following APIs are changed in stage 2
Accession
Accession Batch
Both Accession and Accession Batch has the following signature
{ "imsLocationCode":"RECAP", // RECAP for ReCAP Warehouse, HD for Harvard Depository "accessionRequests":[ { "customerCode":"PA", "itemBarcode":"PULTST54340" }, { "customerCode":"PA", "itemBarcode":"PULTST54341" }, { "customerCode":"PA", "itemBarcode":"PULTST54342" } ] }
New REST APIs developed by ReCAP LAS
Heartbeat API : An API which will inform SCSB that LAS is up and running and ready to take requests
Request API: An API which will take the request and process at LAS side and send proper response
Heartbeat API:
Request Body
{
"imsLocationCode": "RECAP"
}
Response Body for success
{
"success": true
}
Response Body for failure
If DB is down
{
"success": "false",
"screenMessage": ""
}
if location empty
{
"success": "false",
"screenMessage": "Invalid Location:"
}
if location is invalid
{
"success": "false",
"screenMessage": "Invalid Location: NON-RECAP"
}
Request API :
a) Example of Request Body for Retrieval Request (Same as current ActiveMQ Message)
{
"retrieveItem":{
"ttitem":[
{
"itemBarcode":"33433107439345",
"itemStatus":null,
"customerCode":"NA",
"destination":"QX",
"requestId":"729620",
"requestor":"22101008577603"
}
]
}
}
Example of Response Body for Retrieval Request (Same as current ActiveMQ Message)
{
"retrieveItem":{
"ttitem":[
{
"itemBarcode":"33433107439345",
"itemStatus":null,
"customerCode":"NA",
"destination":"QX",
"requestId":"729620",
"requestor":"22101008577603",
"errorCode":"",
"errorNote":""
}
]
}
b) Example request body for EDD request ( Same as current ActiveMQ Message)
{
"retrieveEDD":{
"ttitem":[
{
"itemBarcode":"32101047104110",
"customerCode":"PA",
"requestId":729778,
"requestor":"198572131",
"requestorFirstName":null,
"requestorLastName":null,
"requestorMiddleName":null,
"requestorEmail":"zajicek@princeton.edu",
"requestorOther":null,
"biblioTitle":"Toplumsal hareketler konus?uyor / yay?na haz?rlayan Leyla Sanl?.",
"biblioLocation":"HN656.5.Z9 S686 2003",
"biblioAuthor":" ",
"biblioVolume":null,
"biblioCode":null,
"articleTitle":"TOC, Chapter: Akkuyu Cernobil Olmadi",
"articleAuthor":"",
"articleVolume":", ",
"articleIssue":"",
"articleDate":null,
"startPage":"95",
"endPage":"118",
"pages":null,
"other":null,
"priority":null,
"notes":"",
"requestDate":null,
"requestTime":null,
"errorCode":null,
"errorNote":null
}
]
}
}
Example response body for EDD requests
{
"retrieveEDD":{
"ttitem":[
{
"itemBarcode":"32101047104110",
"customerCode":"PA",
"requestId":729778,
"requestor":"198572131",
"requestorFirstName":null,
"requestorLastName":null,
"requestorMiddleName":null,
"requestorEmail":"zajicek@princeton.edu",
"requestorOther":null,
"biblioTitle":"Toplumsal hareketler konus?uyor \/ yay?na haz?rlayan Leyla Sanl?.",
"biblioLocation":"HN656.5.Z9 S686 2003",
"biblioAuthor":" ",
"biblioVolume":null,
"biblioCode":null,
"articleTitle":"TOC, Chapter: Akkuyu Cernobil Olmadi",
"articleAuthor":"",
"articleVolume":", ",
"articleIssue":"",
"articleDate":null,
"startPage":"95",
"endPage":"118",
"pages":null,
"other":null,
"priority":null,
"notes":"",
"requestDate":null,
"requestTime":null,
"errorCode":"",
"errorNote":""
}
]
}
}