Trendsic Platform Service

<back to all web services

FormFillStatusRequest

The following routes are available for this service:
GET/v1/formfill/status/{Token}
"use strict";
export class FormFillStage {
    /** @param {{Id?:string,Label?:string,Tone?:string,Kind?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Label;
    /** @type {string} */
    Tone;
    /** @type {string} */
    Kind;
}
export class FormFillStageSeen {
    /** @param {{Id?:string,At?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    At;
}
export class FormFillReceiptLine {
    /** @param {{Channel?:string,To?:string,Outcome?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Channel;
    /** @type {string} */
    To;
    /** @type {string} */
    Outcome;
}
export class FormFillStatusResponse {
    /** @param {{Number?:string,FormName?:string,Noun?:string,TenantName?:string,Stage?:string,StageKind?:string,Stages?:FormFillStage[],Seen?:FormFillStageSeen[],SubmittedAt?:string,Receipt?:FormFillReceiptLine[],CanWithdraw?:boolean,Lang?:string,NounEs?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Number;
    /** @type {string} */
    FormName;
    /** @type {string} */
    Noun;
    /** @type {string} */
    TenantName;
    /** @type {string} */
    Stage;
    /** @type {string} */
    StageKind;
    /** @type {FormFillStage[]} */
    Stages = [];
    /** @type {FormFillStageSeen[]} */
    Seen = [];
    /** @type {?string} */
    SubmittedAt;
    /** @type {FormFillReceiptLine[]} */
    Receipt = [];
    /** @type {boolean} */
    CanWithdraw;
    /** @type {string} */
    Lang;
    /** @type {string} */
    NounEs;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormFillStatusRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

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

GET /v1/formfill/status/{Token} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormFillStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanWithdraw>false</CanWithdraw>
  <FormName>String</FormName>
  <Lang>String</Lang>
  <Noun>String</Noun>
  <NounEs>String</NounEs>
  <Number>String</Number>
  <Receipt>
    <FormFillReceiptLine>
      <Channel>String</Channel>
      <Outcome>String</Outcome>
      <To>String</To>
    </FormFillReceiptLine>
  </Receipt>
  <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>
  <Seen>
    <FormFillStageSeen>
      <At>0001-01-01T00:00:00</At>
      <Id>String</Id>
    </FormFillStageSeen>
  </Seen>
  <Stage>String</Stage>
  <StageKind>String</StageKind>
  <Stages>
    <FormFillStage>
      <Id>String</Id>
      <Kind>String</Kind>
      <Label>String</Label>
      <Tone>String</Tone>
    </FormFillStage>
  </Stages>
  <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
  <TenantName>String</TenantName>
</FormFillStatusResponse>