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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<NotificationRecipientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <NotificationRecipient>
    <NotificationRecipientExtended>
      <Folder>String</Folder>
      <IsDeleted>false</IsDeleted>
      <IsImportant>false</IsImportant>
      <IsRead>false</IsRead>
      <IsStarred>false</IsStarred>
      <NotificationMessageId>0</NotificationMessageId>
      <NotificationRecipientId>0</NotificationRecipientId>
      <RecipientId>0</RecipientId>
      <RecipientName>String</RecipientName>
    </NotificationRecipientExtended>
  </NotificationRecipient>
</NotificationRecipientRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationRecipientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <NotificationRecipient>
    <NotificationRecipientExtended>
      <Folder>String</Folder>
      <IsDeleted>false</IsDeleted>
      <IsImportant>false</IsImportant>
      <IsRead>false</IsRead>
      <IsStarred>false</IsStarred>
      <NotificationMessageId>0</NotificationMessageId>
      <NotificationRecipientId>0</NotificationRecipientId>
      <RecipientId>0</RecipientId>
      <RecipientName>String</RecipientName>
    </NotificationRecipientExtended>
  </NotificationRecipient>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NotificationRecipientResponse>