API Method EventNotificationStatusesGetByBulkIds
From Updox API
Contents |
Description
The following describes the processes involved when retrieving notifications by their bulk identification id.
A bulk event notification consists of a JSON object populated with a list of strings. Each string should consist of only one bulk identification id.
Field Validations
bulkNotificationIds
- Required - The list cannot be empty, however, it can contain only a single empty string. This will however return 0 results. For multiple bulk lookups, additional IDs can be added to this list.
Prerequisites
1 This API call requires Vendor-level credentials. The credentials should be populated into the applicationId
and applicationPassword
fields of the auth
block:
{ ... "auth": { "applicationId": "vendorId", "applicationPassword": "vendorPassword", "accountId": "", "userId": "" } }
2 This API call requires a Practice/Account-level identifier. The identifier should be populated into the accountId
field of the auth
block:
{
...
"auth": {
"applicationId": "vendorId",
"applicationPassword": "vendorPassword",
"accountId": "practiceId",
"userId": ""
}
}
Messages
Destination Address
Request JSON
{
"bulkNotificationIds": [ "8", "7" ]
}
HTTP Response Status
200 OK
Response JSON
{
"successful": true, "responseMessage": "OK", "responseCode": 2000, "eventNotificationStatuses": [ { "notificationId": 13, "internalId": "XYZ", "status": "error", "statusDate": "12/11/2015", "reply": "N/A" }, { "notificationId": 14, "internalId": "ABC", "status": "created", "statusDate": "12/11/2015", "reply": "YES" } ]
}
Response Codes
5012 At least one id must be specified for the get request
This method may also return the General Error Set.