Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/search
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormAnswerCond
    {
        public virtual string F { get; set; }
        public virtual string Op { get; set; }
        public virtual string V { get; set; }
    }

    public partial class FormFilterField
    {
        public virtual string K { get; set; }
        public virtual string L { get; set; }
        public virtual string T { get; set; }
        public virtual List<FormFilterOpt> Opts { get; set; } = [];
    }

    public partial class FormFilterOpt
    {
        public virtual string Id { get; set; }
        public virtual string L { get; set; }
    }

    public partial class FormInboxCount
    {
        public virtual string V { get; set; }
        public virtual string L { get; set; }
        public virtual int N { get; set; }
    }

    public partial class FormInboxCounts
    {
        public virtual List<FormInboxCount> Stages { get; set; } = [];
        public virtual List<FormInboxCount> Assignees { get; set; } = [];
        public virtual List<FormInboxCount> Branches { get; set; } = [];
        public virtual List<FormInboxCount> Tags { get; set; } = [];
        public virtual List<FormInboxCount> Forms { get; set; } = [];
        public virtual List<FormInboxCount> Flags { get; set; } = [];
    }

    public partial class FormInboxRow
    {
        public virtual Guid SubmissionUID { get; set; }
        public virtual Guid FormUID { get; set; }
        public virtual string FormName { get; set; }
        public virtual int VersionNo { get; set; }
        public virtual string Number { get; set; }
        public virtual string ApplicantName { get; set; }
        public virtual string Stage { get; set; }
        public virtual string StageLabel { get; set; }
        public virtual string StageTone { get; set; }
        public virtual int? AssigneeAgentId { get; set; }
        public virtual string AssigneeName { get; set; }
        public virtual string BranchName { get; set; }
        public virtual DateTime? SubmittedAt { get; set; }
        public virtual string SubmittedText { get; set; }
        public virtual List<string> Tags { get; set; } = [];
        public virtual int DocsOk { get; set; }
        public virtual int DocsNeed { get; set; }
        public virtual bool IsTest { get; set; }
        public virtual string VersionText { get; set; }
    }

    public partial class FormStageInfo
    {
        public virtual string Id { get; set; }
        public virtual string Label { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Kind { get; set; }
    }

    public partial class FormSubmissionSearchRequest
    {
        public virtual Guid? FormUID { get; set; }
        public virtual string Mode { get; set; }
        public virtual List<Guid> Forms { get; set; } = [];
        public virtual List<string> Stages { get; set; } = [];
        public virtual List<int> Assignees { get; set; } = [];
        public virtual List<string> Branches { get; set; } = [];
        public virtual List<string> Tags { get; set; } = [];
        public virtual string Search { get; set; }
        public virtual string SortKey { get; set; }
        public virtual int SortDir { get; set; }
        public virtual int Skip { get; set; }
        public virtual int Take { get; set; }
        public virtual List<FormAnswerCond> Conds { get; set; } = [];
        public virtual List<string> Flags { get; set; } = [];
    }

    public partial class FormSubmissionSearchResponse
    {
        public virtual List<FormInboxRow> Rows { get; set; } = [];
        public virtual int Matching { get; set; }
        public virtual int ScopeTotal { get; set; }
        public virtual List<FormInboxCount> StageMatching { get; set; } = [];
        public virtual FormInboxCounts Counts { get; set; }
        public virtual List<FormStageInfo> Stages { get; set; } = [];
        public virtual bool Capped { get; set; }
        public virtual List<FormFilterField> FilterFields { get; set; } = [];
        public virtual List<string> TagOptions { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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"}}}