Trendsic Platform Service

<back to all web services

FormSubmissionExportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/export/preview
"use strict";
export class FormSubmissionExportPreviewResponse {
    /** @param {{Rows?:number,Cap?:number,FormName?:string,CanExport?:boolean,Message?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Rows;
    /** @type {number} */
    Cap;
    /** @type {string} */
    FormName;
    /** @type {boolean} */
    CanExport;
    /** @type {string} */
    Message;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormAnswerCond {
    /** @param {{F?:string,Op?:string,V?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    F;
    /** @type {string} */
    Op;
    /** @type {string} */
    V;
}
export class FormSubmissionSearchRequest {
    /** @param {{FormUID?:string,Mode?:string,Forms?:string[],Stages?:string[],Assignees?:number[],Branches?:string[],Tags?:string[],Search?:string,SortKey?:string,SortDir?:number,Skip?:number,Take?:number,Conds?:FormAnswerCond[],Flags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    FormUID;
    /** @type {string} */
    Mode;
    /** @type {string[]} */
    Forms = [];
    /** @type {string[]} */
    Stages = [];
    /** @type {number[]} */
    Assignees = [];
    /** @type {string[]} */
    Branches = [];
    /** @type {string[]} */
    Tags = [];
    /** @type {string} */
    Search;
    /** @type {string} */
    SortKey;
    /** @type {number} */
    SortDir;
    /** @type {number} */
    Skip;
    /** @type {number} */
    Take;
    /** @type {FormAnswerCond[]} */
    Conds = [];
    /** @type {string[]} */
    Flags = [];
}
export class FormSubmissionExportPreviewRequest {
    /** @param {{Query?:FormSubmissionSearchRequest,SubmissionUIDs?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormSubmissionSearchRequest} */
    Query;
    /** @type {string[]} */
    SubmissionUIDs = [];
}

JavaScript FormSubmissionExportPreviewRequest 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/export/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormSubmissionExportPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Query>
    <Assignees xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Assignees>
    <Branches xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Branches>
    <Conds>
      <FormAnswerCond>
        <F>String</F>
        <Op>String</Op>
        <V>String</V>
      </FormAnswerCond>
    </Conds>
    <Flags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Flags>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Forms xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </Forms>
    <Mode>String</Mode>
    <Search>String</Search>
    <Skip>0</Skip>
    <SortDir>0</SortDir>
    <SortKey>String</SortKey>
    <Stages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Stages>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <Take>0</Take>
  </Query>
  <SubmissionUIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SubmissionUIDs>
</FormSubmissionExportPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionExportPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanExport>false</CanExport>
  <Cap>0</Cap>
  <FormName>String</FormName>
  <Message>String</Message>
  <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>
  <Rows>0</Rows>
</FormSubmissionExportPreviewResponse>