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

public class NotificationsRequest : Codable
{
    required public init(){}
}

public class NotificationsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var notifications:[Notification] = []

    required public init(){}
}

public class Notification : NotificationHeader
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class NotificationHeader : Codable
{
    public var notificationHeaderId:Int
    public var subject:String
    public var status:String
    public var needsCloseApproval:Bool
    public var isDeleted:Bool
    public var createdBy:Int
    public var dateCreated:Date

    required public init(){}
}


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