Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/search

export class FormInboxRow
{
    public SubmissionUID: string;
    public FormUID: string;
    public FormName: string;
    public VersionNo: number;
    public Number: string;
    public ApplicantName: string;
    public Stage: string;
    public StageLabel: string;
    public StageTone: string;
    public AssigneeAgentId?: number;
    public AssigneeName: string;
    public BranchName: string;
    public SubmittedAt?: string;
    public SubmittedText: string;
    public Tags: string[] = [];
    public DocsOk: number;
    public DocsNeed: number;
    public IsTest: boolean;
    public VersionText: string;

    public constructor(init?: Partial<FormInboxRow>) { (Object as any).assign(this, init); }
}

export class FormInboxCount
{
    public V: string;
    public L: string;
    public N: number;

    public constructor(init?: Partial<FormInboxCount>) { (Object as any).assign(this, init); }
}

export class FormInboxCounts
{
    public Stages: FormInboxCount[] = [];
    public Assignees: FormInboxCount[] = [];
    public Branches: FormInboxCount[] = [];
    public Tags: FormInboxCount[] = [];
    public Forms: FormInboxCount[] = [];
    public Flags: FormInboxCount[] = [];

    public constructor(init?: Partial<FormInboxCounts>) { (Object as any).assign(this, init); }
}

export class FormStageInfo
{
    public Id: string;
    public Label: string;
    public Tone: string;
    public Kind: string;

    public constructor(init?: Partial<FormStageInfo>) { (Object as any).assign(this, init); }
}

export class FormFilterOpt
{
    public Id: string;
    public L: string;

    public constructor(init?: Partial<FormFilterOpt>) { (Object as any).assign(this, init); }
}

export class FormFilterField
{
    public K: string;
    public L: string;
    public T: string;
    public Opts: FormFilterOpt[] = [];

    public constructor(init?: Partial<FormFilterField>) { (Object as any).assign(this, init); }
}

export class FormSubmissionSearchResponse
{
    public Rows: FormInboxRow[] = [];
    public Matching: number;
    public ScopeTotal: number;
    public StageMatching: FormInboxCount[] = [];
    public Counts: FormInboxCounts;
    public Stages: FormStageInfo[] = [];
    public Capped: boolean;
    public FilterFields: FormFilterField[] = [];
    public TagOptions: string[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormSubmissionSearchResponse>) { (Object as any).assign(this, init); }
}

export class FormAnswerCond
{
    public F: string;
    public Op: string;
    public V: string;

    public constructor(init?: Partial<FormAnswerCond>) { (Object as any).assign(this, init); }
}

export class FormSubmissionSearchRequest
{
    public FormUID?: string;
    public Mode: string;
    public Forms: string[] = [];
    public Stages: string[] = [];
    public Assignees: number[] = [];
    public Branches: string[] = [];
    public Tags: string[] = [];
    public Search: string;
    public SortKey: string;
    public SortDir: number;
    public Skip: number;
    public Take: number;
    public Conds: FormAnswerCond[] = [];
    public Flags: string[] = [];

    public constructor(init?: Partial<FormSubmissionSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>