Trendsic Platform Service

<back to all web services

DispatchNoticeAckRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/notice/{Token}/ack
"use strict";
export class DispatchNoticeResponse {
    /** @param {{RefCode?:string,RecipientName?:string,Headline?:string,Body?:string,AffectedText?:string,OriginalWindow?:string,NewWindow?:string,ScopeLabel?:string,Reason?:string,HoldStatus?:string,ResumesUtc?:string,Acked?:boolean,Invalid?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RefCode;
    /** @type {string} */
    RecipientName;
    /** @type {string} */
    Headline;
    /** @type {string} */
    Body;
    /** @type {string} */
    AffectedText;
    /** @type {string} */
    OriginalWindow;
    /** @type {string} */
    NewWindow;
    /** @type {string} */
    ScopeLabel;
    /** @type {string} */
    Reason;
    /** @type {string} */
    HoldStatus;
    /** @type {?string} */
    ResumesUtc;
    /** @type {boolean} */
    Acked;
    /** @type {boolean} */
    Invalid;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchNoticeAckRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

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

POST /v1/dispatch/notice/{Token}/ack HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchNoticeAckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Token>String</Token>
</DispatchNoticeAckRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchNoticeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Acked>false</Acked>
  <AffectedText>String</AffectedText>
  <Body>String</Body>
  <Headline>String</Headline>
  <HoldStatus>String</HoldStatus>
  <Invalid>false</Invalid>
  <NewWindow>String</NewWindow>
  <OriginalWindow>String</OriginalWindow>
  <Reason>String</Reason>
  <RecipientName>String</RecipientName>
  <RefCode>String</RefCode>
  <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>
  <ResumesUtc>0001-01-01T00:00:00</ResumesUtc>
  <ScopeLabel>String</ScopeLabel>
</DispatchNoticeResponse>