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 .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.

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

<NoticeReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <NoticeType>String</NoticeType>
</NoticeReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NoticeReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Notices>
    <NoticeAgreement>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <FirstViewed>0001-01-01T00:00:00</FirstViewed>
      <Id>0</Id>
      <SignedDate>0001-01-01T00:00:00</SignedDate>
      <SnoozedDate>0001-01-01T00:00:00</SnoozedDate>
      <Status>String</Status>
    </NoticeAgreement>
  </Notices>
  <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>
</NoticeReportResponse>