Trendsic Platform Service

<back to all web services

FormSubmissionRequestPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info/preview
"use strict";
export class FormRequestItem {
    /** @param {{K?:string,L?:string,Tag?:string,Tone?:string,Pre?:boolean,IsSignature?:boolean,IsSensitive?:boolean,Pi?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    K;
    /** @type {string} */
    L;
    /** @type {string} */
    Tag;
    /** @type {string} */
    Tone;
    /** @type {boolean} */
    Pre;
    /** @type {boolean} */
    IsSignature;
    /** @type {boolean} */
    IsSensitive;
    /** @type {number} */
    Pi;
}
export class FormRequestPlan {
    /** @param {{Items?:FormRequestItem[],Keys?:string[],Resign?:string[],ResignKeys?:string[],Channels?:string,StageLabel?:string,Consequence?:string,Applicant?:string,Stage?:string,CanSend?:boolean,Refusal?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormRequestItem[]} */
    Items = [];
    /** @type {string[]} */
    Keys = [];
    /** @type {string[]} */
    Resign = [];
    /** @type {string[]} */
    ResignKeys = [];
    /** @type {string} */
    Channels;
    /** @type {string} */
    StageLabel;
    /** @type {string} */
    Consequence;
    /** @type {string} */
    Applicant;
    /** @type {string} */
    Stage;
    /** @type {boolean} */
    CanSend;
    /** @type {string} */
    Refusal;
}
export class FormSubmissionRequestPreviewResponse {
    /** @param {{Plan?:FormRequestPlan,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormRequestPlan} */
    Plan;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormSubmissionRequestPreviewRequest {
    /** @param {{SubmissionUID?:string,Keys?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SubmissionUID;
    /** @type {string[]} */
    Keys = [];
}

JavaScript FormSubmissionRequestPreviewRequest 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/forms/submissions/{SubmissionUID}/request-info/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormSubmissionRequestPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionRequestPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionRequestPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Plan>
    <Applicant>String</Applicant>
    <CanSend>false</CanSend>
    <Channels>String</Channels>
    <Consequence>String</Consequence>
    <Items>
      <FormRequestItem>
        <IsSensitive>false</IsSensitive>
        <IsSignature>false</IsSignature>
        <K>String</K>
        <L>String</L>
        <Pi>0</Pi>
        <Pre>false</Pre>
        <Tag>String</Tag>
        <Tone>String</Tone>
      </FormRequestItem>
    </Items>
    <Keys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Keys>
    <Refusal>String</Refusal>
    <Resign xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Resign>
    <ResignKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </ResignKeys>
    <Stage>String</Stage>
    <StageLabel>String</StageLabel>
  </Plan>
  <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>
</FormSubmissionRequestPreviewResponse>