Trendsic Platform Service

<back to all web services

NotificationRecipientRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationRecipient/{NotificationRecipientId}
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationRecipient
NotificationRecipientRequest Parameters:
NameParameterData TypeRequiredDescription
NotificationRecipientbodyList<NotificationRecipientExtended>No
NotificationRecipientExtended Parameters:
NameParameterData TypeRequiredDescription
RecipientNameformstringNo
NotificationRecipient Parameters:
NameParameterData TypeRequiredDescription
NotificationRecipientIdformintNo
NotificationMessageIdformintNo
RecipientIdformintNo
FolderformstringNo
IsStarredformboolNo
IsImportantformboolNo
IsReadformboolNo
IsDeletedformboolNo
NotificationRecipientResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NotificationRecipientformList<NotificationRecipientExtended>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/NotificationRecipient/{NotificationRecipientId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"NotificationRecipient":[{"RecipientName":"String","NotificationRecipientId":0,"NotificationMessageId":0,"RecipientId":0,"Folder":"String","IsStarred":false,"IsImportant":false,"IsRead":false,"IsDeleted":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"NotificationRecipient":[{"RecipientName":"String","NotificationRecipientId":0,"NotificationMessageId":0,"RecipientId":0,"Folder":"String","IsStarred":false,"IsImportant":false,"IsRead":false,"IsDeleted":false}]}