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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"FormUID":"00000000000000000000000000000000","Mode":"String","Forms":["00000000000000000000000000000000"],"Stages":["String"],"Assignees":[0],"Branches":["String"],"Tags":["String"],"Search":"String","SortKey":"String","SortDir":0,"Skip":0,"Take":0,"Conds":[{"F":"String","Op":"String","V":"String"}],"Flags":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Rows":[{"SubmissionUID":"00000000000000000000000000000000","FormUID":"00000000000000000000000000000000","FormName":"String","VersionNo":0,"Number":"String","ApplicantName":"String","Stage":"String","StageLabel":"String","StageTone":"String","AssigneeAgentId":0,"AssigneeName":"String","BranchName":"String","SubmittedAt":"0001-01-01T00:00:00.0000000","SubmittedText":"String","Tags":["String"],"DocsOk":0,"DocsNeed":0,"IsTest":false,"VersionText":"String"}],"Matching":0,"ScopeTotal":0,"StageMatching":[{"V":"String","L":"String","N":0}],"Counts":{"Stages":[{"V":"String","L":"String","N":0}],"Assignees":[{"V":"String","L":"String","N":0}],"Branches":[{"V":"String","L":"String","N":0}],"Tags":[{"V":"String","L":"String","N":0}],"Forms":[{"V":"String","L":"String","N":0}],"Flags":[{"V":"String","L":"String","N":0}]},"Stages":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"Capped":false,"FilterFields":[{"K":"String","L":"String","T":"String","Opts":[{"Id":"String","L":"String"}]}],"TagOptions":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}