POST api/v1/notifications/SendSystem
Request Information
URI Parameters
None.
Body Parameters
SendSystemNotificationDto| Name | Description | Type | Additional information |
|---|---|---|---|
| OrganizationCode | string |
None. |
|
| NotificationConfigCode | string |
None. |
|
| Recipients | Collection of string |
None. |
|
| CustomerId | globally unique identifier |
None. |
|
| Data | Dictionary of string [key] and string [value] |
None. |
Request Formats
application/json, text/json
Sample:
{
"organizationCode": "sample string 1",
"notificationConfigCode": "sample string 2",
"recipients": [
"sample string 1",
"sample string 2"
],
"customerId": "89cc1ab3-4718-463a-825f-b048d8e1a049",
"data": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<SendSystemNotificationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Application.Services.Dtos">
<CustomerId>89cc1ab3-4718-463a-825f-b048d8e1a049</CustomerId>
<Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Data>
<NotificationConfigCode>sample string 2</NotificationConfigCode>
<OrganizationCode>sample string 1</OrganizationCode>
<Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Recipients>
</SendSystemNotificationDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.