Category Archives: Results API

GET /results

Posted on by

Get all results in the system after a certain date.

Resource URL:

http://slingshot.surgentnetworks.com/notificationplatform-web/api/results

Header Parameters:

Parameter Value Required?
If-Modified-Since Date (RFC 1123) No
Accept application/json or application/xml Yes

Expected Result:
Header:

HTTP/1.1 200 OK

Body:
Example / JSON

[
{
"resultId":1234,
"notificationId":"123456",
"notificationCustomerId":null,
"timeOfCall":"2015-05-05T02:33:53-04:00",
"callDuration":"0",
"slingshotResultCode":"900",
"moduleResultCode":null,
"moduleResultMessage":null,
"clientResultMessage":"xxx",
"history":null
},
{
"resultId":4321,
"notificationId":"54321",
"notificationCustomerId":"yyy",
"timeOfCall":"2015-05-05T02:34:06-04:00",
"callDuration":"27063",
"slingshotResultCode":"200",
"moduleResultCode":null,
"moduleResultMessage":null,
"clientResultMessage":null,
"history":null
}
]

GET /results/notification/uniqueid/:id

Posted on by

Pull the result history for one specific notification by system ID

Resource URL:

GET http://slingshot.surgentnetworks.com/api/results/notification/uniqueid/[id]

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes
Accept application/json or application/xml Yes

Expected Result:
Header:

HTTP/1.1 201 Created

Body:
Example / JSON

[
   { 
      "callId":"1448240515672testNot1122",
      "appId":null,
      "callAlertId":"testNot1122",
      "callDate":"2015-11-22T20:02:28-05:00",
      "callPriority":1,
      "callbackNumber":"16665557777",
      "outboundCallNumber":"18579917607",
      "requestedCompletionTime":"2022-10-02T11:00:00-04:00",
      "requestedStartTime":"2012-10-02T11:00:00-04:00",
      "campaignId":null,
      "timezone":null,
      "results":[ 
         { 
            "resultId":3440,
            "notificationId":"1448240515672testNot1122",
            "timeOfCall":"2015-11-22T20:02:28-05:00",
            "callDuration":"4840",
            "SlingShotResultCode":"200",
            "moduleResultCode":null,
            "moduleResultMessage":null,
            "clientResultMessage":null
         }
      ]
   }
]

GET /notification/cust/:id

Posted on by

Pull the notification information by reference ID entered by a user.

Resource URL:

GET http://slingshot.surgentnetworks.com/api/notification/cust/134816595720120

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes
Accept application/json or application/xml Yes

Expected Result:
Header:

HTTP/1.1 200 OK

Body:
Example / JSON

[
{
"callId":"1448240515672testNot1122",
"appId":null,
"callAlertId":"testNot1122",
"callDate":"2015-11-22T20:02:28-05:00",
"callPriority":1,
"callbackNumber":"16665557777",
"outboundCallNumber":"18579917607",
"requestedCompletionTime":"2022-10-02T11:00:00-04:00",
"requestedStartTime":"2012-10-02T11:00:00-04:00",
"campaignId":null,
"timezone":null,
"results":[
{
"resultId":3440,
"notificationId":"1448240515672testNot1122",
"timeOfCall":"2015-11-22T20:02:28-05:00",
"callDuration":"4840",
"SlingShotResultCode":"200",
"moduleResultCode":null,
"moduleResultMessage":null,
"clientResultMessage":null
}
]
}
]