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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class NotificationRecipientRequest
{
    open var NotificationRecipient:ArrayList<NotificationRecipientExtended> = ArrayList<NotificationRecipientExtended>()
}

open class NotificationRecipientExtended : NotificationRecipient()
{
    open var RecipientName:String? = null
}

open class NotificationRecipient
{
    open var NotificationRecipientId:Int? = null
    open var NotificationMessageId:Int? = null
    open var RecipientId:Int? = null
    open var Folder:String? = null
    open var IsStarred:Boolean? = null
    open var IsImportant:Boolean? = null
    open var IsRead:Boolean? = null
    open var IsDeleted:Boolean? = null
}

open class NotificationRecipientResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var NotificationRecipient:ArrayList<NotificationRecipientExtended> = ArrayList<NotificationRecipientExtended>()
}

Kotlin 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
		}
	]
}