Difference between revisions of "API Method EventNotificationBulkCreate"
From Updox API
(→Description) |
(→Field Validations) |
||
Line 9: | Line 9: | ||
== Field Validations == | == Field Validations == | ||
+ | |||
+ | * payload | ||
+ | |||
+ | * internalId | ||
+ | |||
+ | * deliveryDateTime | ||
+ | |||
+ | * deliveryDestination | ||
+ | |||
+ | * deliveryMethod | ||
== Prerequisites == | == Prerequisites == |
Revision as of 17:01, 11 December 2015
Description
The following describes the processes involved when sending bulk event notifications.
A bulk event notification consists of a JSON object populated with a list of:
- payload (the content of the notification) - internal id (an identification id specified by the requester) - delivery date/time - delivery method
Field Validations
* payload
* internalId
* deliveryDateTime
* deliveryDestination
* deliveryMethod
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": ""
}
}