Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/search
"use strict";
export class FormInboxRow {
    /** @param {{SubmissionUID?:string,FormUID?:string,FormName?:string,VersionNo?:number,Number?:string,ApplicantName?:string,Stage?:string,StageLabel?:string,StageTone?:string,AssigneeAgentId?:number,AssigneeName?:string,BranchName?:string,SubmittedAt?:string,SubmittedText?:string,Tags?:string[],DocsOk?:number,DocsNeed?:number,IsTest?:boolean,VersionText?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SubmissionUID;
    /** @type {string} */
    FormUID;
    /** @type {string} */
    FormName;
    /** @type {number} */
    VersionNo;
    /** @type {string} */
    Number;
    /** @type {string} */
    ApplicantName;
    /** @type {string} */
    Stage;
    /** @type {string} */
    StageLabel;
    /** @type {string} */
    StageTone;
    /** @type {?number} */
    AssigneeAgentId;
    /** @type {string} */
    AssigneeName;
    /** @type {string} */
    BranchName;
    /** @type {?string} */
    SubmittedAt;
    /** @type {string} */
    SubmittedText;
    /** @type {string[]} */
    Tags = [];
    /** @type {number} */
    DocsOk;
    /** @type {number} */
    DocsNeed;
    /** @type {boolean} */
    IsTest;
    /** @type {string} */
    VersionText;
}
export class FormInboxCount {
    /** @param {{V?:string,L?:string,N?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    V;
    /** @type {string} */
    L;
    /** @type {number} */
    N;
}
export class FormInboxCounts {
    /** @param {{Stages?:FormInboxCount[],Assignees?:FormInboxCount[],Branches?:FormInboxCount[],Tags?:FormInboxCount[],Forms?:FormInboxCount[],Flags?:FormInboxCount[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormInboxCount[]} */
    Stages = [];
    /** @type {FormInboxCount[]} */
    Assignees = [];
    /** @type {FormInboxCount[]} */
    Branches = [];
    /** @type {FormInboxCount[]} */
    Tags = [];
    /** @type {FormInboxCount[]} */
    Forms = [];
    /** @type {FormInboxCount[]} */
    Flags = [];
}
export class FormStageInfo {
    /** @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 FormFilterOpt {
    /** @param {{Id?:string,L?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    L;
}
export class FormFilterField {
    /** @param {{K?:string,L?:string,T?:string,Opts?:FormFilterOpt[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    K;
    /** @type {string} */
    L;
    /** @type {string} */
    T;
    /** @type {FormFilterOpt[]} */
    Opts = [];
}
export class FormSubmissionSearchResponse {
    /** @param {{Rows?:FormInboxRow[],Matching?:number,ScopeTotal?:number,StageMatching?:FormInboxCount[],Counts?:FormInboxCounts,Stages?:FormStageInfo[],Capped?:boolean,FilterFields?:FormFilterField[],TagOptions?:string[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormInboxRow[]} */
    Rows = [];
    /** @type {number} */
    Matching;
    /** @type {number} */
    ScopeTotal;
    /** @type {FormInboxCount[]} */
    StageMatching = [];
    /** @type {FormInboxCounts} */
    Counts;
    /** @type {FormStageInfo[]} */
    Stages = [];
    /** @type {boolean} */
    Capped;
    /** @type {FormFilterField[]} */
    FilterFields = [];
    /** @type {string[]} */
    TagOptions = [];
    /** @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 = [];
}

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

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

<FormSubmissionSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Capped>false</Capped>
  <Counts>
    <Assignees>
      <FormInboxCount>
        <L>String</L>
        <N>0</N>
        <V>String</V>
      </FormInboxCount>
    </Assignees>
    <Branches>
      <FormInboxCount>
        <L>String</L>
        <N>0</N>
        <V>String</V>
      </FormInboxCount>
    </Branches>
    <Flags>
      <FormInboxCount>
        <L>String</L>
        <N>0</N>
        <V>String</V>
      </FormInboxCount>
    </Flags>
    <Forms>
      <FormInboxCount>
        <L>String</L>
        <N>0</N>
        <V>String</V>
      </FormInboxCount>
    </Forms>
    <Stages>
      <FormInboxCount>
        <L>String</L>
        <N>0</N>
        <V>String</V>
      </FormInboxCount>
    </Stages>
    <Tags>
      <FormInboxCount>
        <L>String</L>
        <N>0</N>
        <V>String</V>
      </FormInboxCount>
    </Tags>
  </Counts>
  <FilterFields>
    <FormFilterField>
      <K>String</K>
      <L>String</L>
      <Opts>
        <FormFilterOpt>
          <Id>String</Id>
          <L>String</L>
        </FormFilterOpt>
      </Opts>
      <T>String</T>
    </FormFilterField>
  </FilterFields>
  <Matching>0</Matching>
  <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>
    <FormInboxRow>
      <ApplicantName>String</ApplicantName>
      <AssigneeAgentId>0</AssigneeAgentId>
      <AssigneeName>String</AssigneeName>
      <BranchName>String</BranchName>
      <DocsNeed>0</DocsNeed>
      <DocsOk>0</DocsOk>
      <FormName>String</FormName>
      <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
      <IsTest>false</IsTest>
      <Number>String</Number>
      <Stage>String</Stage>
      <StageLabel>String</StageLabel>
      <StageTone>String</StageTone>
      <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
      <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
      <SubmittedText>String</SubmittedText>
      <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Tags>
      <VersionNo>0</VersionNo>
      <VersionText>String</VersionText>
    </FormInboxRow>
  </Rows>
  <ScopeTotal>0</ScopeTotal>
  <StageMatching>
    <FormInboxCount>
      <L>String</L>
      <N>0</N>
      <V>String</V>
    </FormInboxCount>
  </StageMatching>
  <Stages>
    <FormStageInfo>
      <Id>String</Id>
      <Kind>String</Kind>
      <Label>String</Label>
      <Tone>String</Tone>
    </FormStageInfo>
  </Stages>
  <TagOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TagOptions>
</FormSubmissionSearchResponse>