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}
"use strict";
export class NoticeAgreement {
    /** @param {{Id?:number,AgentId?:number,AgentName?:string,Status?:string,SignedDate?:string,FirstViewed?:string,SnoozedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    Status;
    /** @type {string} */
    SignedDate;
    /** @type {string} */
    FirstViewed;
    /** @type {string} */
    SnoozedDate;
}
export class NoticeReportResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Notices?:NoticeAgreement[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {NoticeAgreement[]} */
    Notices = [];
}
export class NoticeReportRequest {
    /** @param {{NoticeType?:string,AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NoticeType;
    /** @type {number} */
    AgentId;
}

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