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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NotificationRecipient() = 
        member val NotificationRecipientId:Int32 = new Int32() with get,set
        member val NotificationMessageId:Int32 = new Int32() with get,set
        member val RecipientId:Int32 = new Int32() with get,set
        member val Folder:String = null with get,set
        member val IsStarred:Boolean = new Boolean() with get,set
        member val IsImportant:Boolean = new Boolean() with get,set
        member val IsRead:Boolean = new Boolean() with get,set
        member val IsDeleted:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type NotificationRecipientExtended() = 
        inherit NotificationRecipient()
        member val RecipientName:String = null with get,set

    [<AllowNullLiteral>]
    type NotificationRecipientResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val NotificationRecipient:ResizeArray<NotificationRecipientExtended> = new ResizeArray<NotificationRecipientExtended>() with get,set

    [<AllowNullLiteral>]
    type NotificationRecipientRequest() = 
        member val NotificationRecipient:ResizeArray<NotificationRecipientExtended> = new ResizeArray<NotificationRecipientExtended>() with get,set

F# 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
		}
	]
}