Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

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

public class FormSubmissionSearchRequest : Codable
{
    public var formUID:String?
    public var mode:String
    public var forms:[String] = []
    public var stages:[String] = []
    public var assignees:[Int] = []
    public var branches:[String] = []
    public var tags:[String] = []
    public var search:String
    public var sortKey:String
    public var sortDir:Int
    public var skip:Int
    public var take:Int
    public var conds:[FormAnswerCond] = []

    required public init(){}
}

public class FormAnswerCond : Codable
{
    public var f:String
    public var op:String
    public var v:String

    required public init(){}
}

public class FormSubmissionSearchResponse : Codable
{
    public var rows:[FormInboxRow] = []
    public var matching:Int
    public var scopeTotal:Int
    public var stageMatching:[FormInboxCount] = []
    public var counts:FormInboxCounts
    public var stages:[FormStageInfo] = []
    public var capped:Bool
    public var filterFields:[FormFilterField] = []
    public var tagOptions:[String] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormInboxRow : Codable
{
    public var submissionUID:String
    public var formUID:String
    public var formName:String
    public var versionNo:Int
    public var number:String
    public var applicantName:String
    public var stage:String
    public var stageLabel:String
    public var stageTone:String
    public var assigneeAgentId:Int?
    public var assigneeName:String
    public var branchName:String
    public var submittedAt:Date?
    public var submittedText:String
    public var tags:[String] = []
    public var docsOk:Int
    public var docsNeed:Int

    required public init(){}
}

public class FormInboxCount : Codable
{
    public var v:String
    public var l:String
    public var n:Int

    required public init(){}
}

public class FormInboxCounts : Codable
{
    public var stages:[FormInboxCount] = []
    public var assignees:[FormInboxCount] = []
    public var branches:[FormInboxCount] = []
    public var tags:[FormInboxCount] = []
    public var forms:[FormInboxCount] = []

    required public init(){}
}

public class FormStageInfo : Codable
{
    public var id:String
    public var label:String
    public var tone:String
    public var kind:String

    required public init(){}
}

public class FormFilterField : Codable
{
    public var k:String
    public var l:String
    public var t:String
    public var opts:[FormFilterOpt] = []

    required public init(){}
}

public class FormFilterOpt : Codable
{
    public var id:String
    public var l:String

    required public init(){}
}


Swift 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"}]}
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}],"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}]},"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"}}}