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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FormSubmissionSearchRequest
{
    open var FormUID:UUID? = null
    open var Mode:String? = null
    open var Forms:ArrayList<UUID> = ArrayList<UUID>()
    open var Stages:ArrayList<String> = ArrayList<String>()
    open var Assignees:ArrayList<Int> = ArrayList<Int>()
    open var Branches:ArrayList<String> = ArrayList<String>()
    open var Tags:ArrayList<String> = ArrayList<String>()
    open var Search:String? = null
    open var SortKey:String? = null
    open var SortDir:Int? = null
    open var Skip:Int? = null
    open var Take:Int? = null
    open var Conds:ArrayList<FormAnswerCond> = ArrayList<FormAnswerCond>()
}

open class FormAnswerCond
{
    open var F:String? = null
    open var Op:String? = null
    open var V:String? = null
}

open class FormSubmissionSearchResponse
{
    open var Rows:ArrayList<FormInboxRow> = ArrayList<FormInboxRow>()
    open var Matching:Int? = null
    open var ScopeTotal:Int? = null
    open var StageMatching:ArrayList<FormInboxCount> = ArrayList<FormInboxCount>()
    open var Counts:FormInboxCounts? = null
    open var Stages:ArrayList<FormStageInfo> = ArrayList<FormStageInfo>()
    open var Capped:Boolean? = null
    open var FilterFields:ArrayList<FormFilterField> = ArrayList<FormFilterField>()
    open var TagOptions:ArrayList<String> = ArrayList<String>()
    open var ResponseStatus:ResponseStatus? = null
}

open class FormInboxRow
{
    open var SubmissionUID:UUID? = null
    open var FormUID:UUID? = null
    open var FormName:String? = null
    open var VersionNo:Int? = null
    open var Number:String? = null
    open var ApplicantName:String? = null
    open var Stage:String? = null
    open var StageLabel:String? = null
    open var StageTone:String? = null
    open var AssigneeAgentId:Int? = null
    open var AssigneeName:String? = null
    open var BranchName:String? = null
    open var SubmittedAt:Date? = null
    open var SubmittedText:String? = null
    open var Tags:ArrayList<String> = ArrayList<String>()
    open var DocsOk:Int? = null
    open var DocsNeed:Int? = null
}

open class FormInboxCount
{
    open var V:String? = null
    open var L:String? = null
    open var N:Int? = null
}

open class FormInboxCounts
{
    open var Stages:ArrayList<FormInboxCount> = ArrayList<FormInboxCount>()
    open var Assignees:ArrayList<FormInboxCount> = ArrayList<FormInboxCount>()
    open var Branches:ArrayList<FormInboxCount> = ArrayList<FormInboxCount>()
    open var Tags:ArrayList<FormInboxCount> = ArrayList<FormInboxCount>()
    open var Forms:ArrayList<FormInboxCount> = ArrayList<FormInboxCount>()
}

open class FormStageInfo
{
    open var Id:String? = null
    open var Label:String? = null
    open var Tone:String? = null
    open var Kind:String? = null
}

open class FormFilterField
{
    open var K:String? = null
    open var L:String? = null
    open var T:String? = null
    open var Opts:ArrayList<FormFilterOpt> = ArrayList<FormFilterOpt>()
}

open class FormFilterOpt
{
    open var Id:String? = null
    open var L:String? = null
}

Kotlin 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"}}}