POST v1/notification/sendNotifiation
Request Information
URI Parameters
None.
Body Parameters
sendNotifiationRequestName | Description | Type | Additional information |
---|---|---|---|
title | string |
None. |
|
message | string |
None. |
|
note_type | notificationType |
None. |
|
createdBy | string |
None. |
|
sendNow | boolean |
None. |
|
companyCode | string |
None. |
|
user_id | integer |
None. |
|
sendDate | string |
None. |
|
sendHour | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "title": "sample string 1", "message": "sample string 2", "note_type": 0, "createdBy": "sample string 3", "sendNow": true, "companyCode": "sample string 5", "user_id": 6, "sendDate": "sample string 7", "sendHour": 8 }
application/xml, text/xml
Sample:
<sendNotifiationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.notification"> <companyCode>sample string 5</companyCode> <createdBy>sample string 3</createdBy> <message>sample string 2</message> <note_type>to_user</note_type> <sendDate>sample string 7</sendDate> <sendHour>8</sendHour> <sendNow>true</sendNow> <title>sample string 1</title> <user_id>6</user_id> </sendNotifiationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
text/html
Sample:
{"title":"sample string 1","message":"sample string 2","note_type":0,"createdBy":"sample string 3","sendNow":true,"companyCode":"sample string 5","user_id":6,"sendDate":"sample string 7","sendHour":8}
Response Information
Resource Description
sendNotifiationResultName | Description | Type | Additional information |
---|---|---|---|
success | boolean |
None. |
|
message | string |
None. |
|
errorMsg | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "success": true, "message": "sample string 2", "errorMsg": "sample string 3" }
application/xml, text/xml
Sample:
<sendNotifiationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.notification"> <errorMsg>sample string 3</errorMsg> <message>sample string 2</message> <success>true</success> </sendNotifiationResult>
text/html
Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3"}