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}
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 NoticeAgreement
            Public Overridable Property Id As Integer
            Public Overridable Property AgentId As Integer
            Public Overridable Property AgentName As String
            Public Overridable Property Status As String
            Public Overridable Property SignedDate As Date
            Public Overridable Property FirstViewed As Date
            Public Overridable Property SnoozedDate As Date
        End Class

        Public Partial Class NoticeReportRequest
            Public Overridable Property NoticeType As String
            Public Overridable Property AgentId As Integer
        End Class

        Public Partial Class NoticeReportResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Notices As List(Of NoticeAgreement) = New List(Of NoticeAgreement)
        End Class
    End Namespace
End Namespace

VB.NET NoticeReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"NoticeType":"String","AgentId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","FirstViewed":"0001-01-01T00:00:00.0000000","SnoozedDate":"0001-01-01T00:00:00.0000000"}]}