Trendsic Platform Service

<back to all web services

UserNotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/UserNotifications/{AgentId}
DELETE,OPTIONS/v1/UserNotifications/{NotificationId}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class UserNotification
            Public Overridable Property NotificationId As Integer
            Public Overridable Property AgentId As Integer
            Public Overridable Property Description As String
            Public Overridable Property From As String
            Public Overridable Property CreatedDate As Date
            Public Overridable Property Type As String
            Public Overridable Property URL As String
            Public Overridable Property RefId As String
            Public Overridable Property IsDeleted As Boolean
        End Class

        Public Partial Class UserNotificationsRequest
            Public Overridable Property AgentId As Integer
            Public Overridable Property NotificationId As Integer
            Public Overridable Property ShowDeleted As Boolean
        End Class

        Public Partial Class UserNotificationsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Notifications As List(Of UserNotification) = New List(Of UserNotification)
            Public Overridable Property Deleted As Boolean
        End Class
    End Namespace
End Namespace

VB.NET UserNotificationsRequest 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.

GET /v1/UserNotifications/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Deleted>false</Deleted>
  <Notifications>
    <UserNotification>
      <AgentId>0</AgentId>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Description>String</Description>
      <From>String</From>
      <IsDeleted>false</IsDeleted>
      <NotificationId>0</NotificationId>
      <RefId>String</RefId>
      <Type>String</Type>
      <URL>String</URL>
    </UserNotification>
  </Notifications>
  <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>
</UserNotificationsResponse>