Trendsic Platform Service

<back to all web services

NotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Notifications
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 Notification
            Inherits NotificationHeader
        End Class

        Public Partial Class NotificationHeader
            Public Overridable Property NotificationHeaderId As Integer
            Public Overridable Property Subject As String
            Public Overridable Property Status As String
            Public Overridable Property NeedsCloseApproval As Boolean
            Public Overridable Property IsDeleted As Boolean
            Public Overridable Property CreatedBy As Integer
            Public Overridable Property DateCreated As Date
        End Class

        Public Partial Class NotificationsRequest
        End Class

        Public Partial Class NotificationsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Notifications As List(Of Notification) = New List(Of Notification)
        End Class
    End Namespace
End Namespace

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

GET /v1/Notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Notifications: 
	[
		{
			NotificationHeaderId: 0,
			Subject: String,
			Status: String,
			NeedsCloseApproval: False,
			IsDeleted: False,
			CreatedBy: 0,
			DateCreated: 0001-01-01
		}
	]
}