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 Foundation
import ServiceStack

public class NotificationRecipientRequest : Codable
{
    public var notificationRecipient:[NotificationRecipientExtended] = []

    required public init(){}
}

public class NotificationRecipientExtended : NotificationRecipient
{
    public var recipientName:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case recipientName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        recipientName = try container.decodeIfPresent(String.self, forKey: .recipientName)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if recipientName != nil { try container.encode(recipientName, forKey: .recipientName) }
    }
}

public class NotificationRecipient : Codable
{
    public var notificationRecipientId:Int
    public var notificationMessageId:Int
    public var recipientId:Int
    public var folder:String
    public var isStarred:Bool
    public var isImportant:Bool
    public var isRead:Bool
    public var isDeleted:Bool

    required public init(){}
}

public class NotificationRecipientResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var notificationRecipient:[NotificationRecipientExtended] = []

    required public init(){}
}


Swift 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>