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

export class NotificationRecipient
{
    public NotificationRecipientId: number;
    public NotificationMessageId: number;
    public RecipientId: number;
    public Folder: string;
    public IsStarred: boolean;
    public IsImportant: boolean;
    public IsRead: boolean;
    public IsDeleted: boolean;

    public constructor(init?: Partial<NotificationRecipient>) { (Object as any).assign(this, init); }
}

export class NotificationRecipientExtended extends NotificationRecipient
{
    public RecipientName: string;

    public constructor(init?: Partial<NotificationRecipientExtended>) { super(init); (Object as any).assign(this, init); }
}

export class NotificationRecipientResponse
{
    public ResponseStatus: ResponseStatus;
    public NotificationRecipient: NotificationRecipientExtended[] = [];

    public constructor(init?: Partial<NotificationRecipientResponse>) { (Object as any).assign(this, init); }
}

export class NotificationRecipientRequest
{
    public NotificationRecipient: NotificationRecipientExtended[] = [];

    public constructor(init?: Partial<NotificationRecipientRequest>) { (Object as any).assign(this, init); }
}

TypeScript NotificationRecipientRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
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
		}
	]
}