Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/search
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormInboxRow() = 
        member val SubmissionUID:Guid = new Guid() with get,set
        member val FormUID:Guid = new Guid() with get,set
        member val FormName:String = null with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val Number:String = null with get,set
        member val ApplicantName:String = null with get,set
        member val Stage:String = null with get,set
        member val StageLabel:String = null with get,set
        member val StageTone:String = null with get,set
        member val AssigneeAgentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AssigneeName:String = null with get,set
        member val BranchName:String = null with get,set
        member val SubmittedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SubmittedText:String = null with get,set
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val DocsOk:Int32 = new Int32() with get,set
        member val DocsNeed:Int32 = new Int32() with get,set
        member val IsTest:Boolean = new Boolean() with get,set
        member val VersionText:String = null with get,set

    [<AllowNullLiteral>]
    type FormInboxCount() = 
        member val V:String = null with get,set
        member val L:String = null with get,set
        member val N:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FormInboxCounts() = 
        member val Stages:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val Assignees:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val Branches:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val Tags:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val Forms:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val Flags:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set

    [<AllowNullLiteral>]
    type FormStageInfo() = 
        member val Id:String = null with get,set
        member val Label:String = null with get,set
        member val Tone:String = null with get,set
        member val Kind:String = null with get,set

    [<AllowNullLiteral>]
    type FormFilterOpt() = 
        member val Id:String = null with get,set
        member val L:String = null with get,set

    [<AllowNullLiteral>]
    type FormFilterField() = 
        member val K:String = null with get,set
        member val L:String = null with get,set
        member val T:String = null with get,set
        member val Opts:ResizeArray<FormFilterOpt> = new ResizeArray<FormFilterOpt>() with get,set

    [<AllowNullLiteral>]
    type FormSubmissionSearchResponse() = 
        member val Rows:ResizeArray<FormInboxRow> = new ResizeArray<FormInboxRow>() with get,set
        member val Matching:Int32 = new Int32() with get,set
        member val ScopeTotal:Int32 = new Int32() with get,set
        member val StageMatching:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val Counts:FormInboxCounts = null with get,set
        member val Stages:ResizeArray<FormStageInfo> = new ResizeArray<FormStageInfo>() with get,set
        member val Capped:Boolean = new Boolean() with get,set
        member val FilterFields:ResizeArray<FormFilterField> = new ResizeArray<FormFilterField>() with get,set
        member val TagOptions:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormAnswerCond() = 
        member val F:String = null with get,set
        member val Op:String = null with get,set
        member val V:String = null with get,set

    [<AllowNullLiteral>]
    type FormSubmissionSearchRequest() = 
        member val FormUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Mode:String = null with get,set
        member val Forms:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val Stages:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Assignees:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val Branches:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Search:String = null with get,set
        member val SortKey:String = null with get,set
        member val SortDir:Int32 = new Int32() with get,set
        member val Skip:Int32 = new Int32() with get,set
        member val Take:Int32 = new Int32() with get,set
        member val Conds:ResizeArray<FormAnswerCond> = new ResizeArray<FormAnswerCond>() with get,set
        member val Flags:ResizeArray<String> = new ResizeArray<String>() with get,set

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