Trendsic Platform Service

<back to all web services

NoticeReportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/GetNoticeReport/{NoticeType}
PUT,OPTIONS/v1/DisableNoticeReport/{NoticeType}/{AgentId}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NoticeAgreement() = 
        member val Id:Int32 = new Int32() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val AgentName:String = null with get,set
        member val Status:String = null with get,set
        member val SignedDate:DateTime = new DateTime() with get,set
        member val FirstViewed:DateTime = new DateTime() with get,set
        member val SnoozedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type NoticeReportResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Notices:ResizeArray<NoticeAgreement> = new ResizeArray<NoticeAgreement>() with get,set

    [<AllowNullLiteral>]
    type NoticeReportRequest() = 
        member val NoticeType:String = null with get,set
        member val AgentId:Int32 = new Int32() with get,set

F# NoticeReportRequest 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.

PUT /v1/GetNoticeReport/{NoticeType} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NoticeType: String,
	AgentId: 0
}
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
		}
	},
	Notices: 
	[
		{
			Id: 0,
			AgentId: 0,
			AgentName: String,
			Status: String,
			SignedDate: 0001-01-01,
			FirstViewed: 0001-01-01,
			SnoozedDate: 0001-01-01
		}
	]
}