IMS - Heartbeat API

Heartbeat API : An API which will inform SCSB that Storage Location IMS System is up and running and ready to take requests

Heartbeat API:

Request Body

{
"imsLocationCode": "<IMS Location>"
}

Example

{
"imsLocationCode": "Storagelocation"
}

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"
}

Shared Collection Service Bus (SCSB) Guide