Notify: The Notify method allows you to send notifications.
REQUEST ATTRIBUTES
attentionLevel |
byte |
|
|---|---|---|
cancelWhenOpen |
boolean |
If set to true, viewing the app instance is sufficient to cancel the notification If set to false, a submission of the app instance will be needed to cancel the notification |
emailAddress |
string |
The e-mail address the notification is sent to |
appId |
string |
The ID of the app the notification is sent from |
instanceId |
int |
The ID of the instance the notification is sent from |
messageBody |
string |
The body of the notification |
messageSubject |
string |
The subject of the notification |
minutes |
int |
Delay period before sending notification (0 = immediate notification) |
name |
string |
The name that is used to display the notification in PerfectApps |
roleName |
string |
The workflow role associated with the notification |
sendEmail |
boolean |
If set to true an e-mail will be sent. If set to false an e-mail will not be sent. |
tokenIn |
string |
This is the security token that is obtained by the previous API call. See API Security topic for more details |
RETURN ATTRIBUTES
NotifyResult |
int |
An integer result indicating success (= 0) or an error (<> 0) |
|---|---|---|
tokenOut |
string |
This is the new security token that should be used for the next function call after this one. See the API Security topic for more details |
REST
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
POST /REST/api/portal/Notify HTTP/1.1 Host: <server url> Content-Type: multipart/form-data
Content-Disposition: form-data; name="attentionLevel" byte Content-Disposition: form-data; name="cancelWhenOpen" boolean Content-Disposition: form-data; name="emailAddress" string Content-Disposition: form-data; name="appId" string Content-Disposition: form-data; name="instanceId" int Content-Disposition: form-data; name="messageBody" string Content-Disposition: form-data; name="messageSubject" string Content-Disposition: form-data; name="minutes" int Content-Disposition: form-data; name="name" string Content-Disposition: form-data; name="roleName" string Content-Disposition: form-data; name="sendEmail" boolean Content-Disposition: form-data; name="tokenIn" string |
HTTP/1.1 200 OK Content-Length: length Content-Type: application/json; charset=utf-8 { "NotifyResult":int, "tokenOut":string } |
Return to: Account API Methods (REST), Integration
