| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/NotificationRecipient/{NotificationRecipientId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/NotificationRecipient |
"use strict";
export class NotificationRecipient {
/** @param {{NotificationRecipientId?:number,NotificationMessageId?:number,RecipientId?:number,Folder?:string,IsStarred?:boolean,IsImportant?:boolean,IsRead?:boolean,IsDeleted?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
NotificationRecipientId;
/** @type {number} */
NotificationMessageId;
/** @type {number} */
RecipientId;
/** @type {string} */
Folder;
/** @type {boolean} */
IsStarred;
/** @type {boolean} */
IsImportant;
/** @type {boolean} */
IsRead;
/** @type {boolean} */
IsDeleted;
}
export class NotificationRecipientExtended extends NotificationRecipient {
/** @param {{RecipientName?:string,NotificationRecipientId?:number,NotificationMessageId?:number,RecipientId?:number,Folder?:string,IsStarred?:boolean,IsImportant?:boolean,IsRead?:boolean,IsDeleted?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
RecipientName;
}
export class NotificationRecipientResponse {
/** @param {{ResponseStatus?:ResponseStatus,NotificationRecipient?:NotificationRecipientExtended[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {NotificationRecipientExtended[]} */
NotificationRecipient = [];
}
export class NotificationRecipientRequest {
/** @param {{NotificationRecipient?:NotificationRecipientExtended[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {NotificationRecipientExtended[]} */
NotificationRecipient = [];
}
JavaScript NotificationRecipientRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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}]}