Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

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

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class FormAnswerCond
            Public Overridable Property F As String
            Public Overridable Property Op As String
            Public Overridable Property V As String
        End Class

        Public Partial Class FormFilterField
            Public Overridable Property K As String
            Public Overridable Property L As String
            Public Overridable Property T As String
            Public Overridable Property Opts As List(Of FormFilterOpt) = New List(Of FormFilterOpt)
        End Class

        Public Partial Class FormFilterOpt
            Public Overridable Property Id As String
            Public Overridable Property L As String
        End Class

        Public Partial Class FormInboxCount
            Public Overridable Property V As String
            Public Overridable Property L As String
            Public Overridable Property N As Integer
        End Class

        Public Partial Class FormInboxCounts
            Public Overridable Property Stages As List(Of FormInboxCount) = New List(Of FormInboxCount)
            Public Overridable Property Assignees As List(Of FormInboxCount) = New List(Of FormInboxCount)
            Public Overridable Property Branches As List(Of FormInboxCount) = New List(Of FormInboxCount)
            Public Overridable Property Tags As List(Of FormInboxCount) = New List(Of FormInboxCount)
            Public Overridable Property Forms As List(Of FormInboxCount) = New List(Of FormInboxCount)
        End Class

        Public Partial Class FormInboxRow
            Public Overridable Property SubmissionUID As Guid
            Public Overridable Property FormUID As Guid
            Public Overridable Property FormName As String
            Public Overridable Property VersionNo As Integer
            Public Overridable Property Number As String
            Public Overridable Property ApplicantName As String
            Public Overridable Property Stage As String
            Public Overridable Property StageLabel As String
            Public Overridable Property StageTone As String
            Public Overridable Property AssigneeAgentId As Integer?
            Public Overridable Property AssigneeName As String
            Public Overridable Property BranchName As String
            Public Overridable Property SubmittedAt As Date?
            Public Overridable Property SubmittedText As String
            Public Overridable Property Tags As List(Of String) = New List(Of String)
            Public Overridable Property DocsOk As Integer
            Public Overridable Property DocsNeed As Integer
        End Class

        Public Partial Class FormStageInfo
            Public Overridable Property Id As String
            Public Overridable Property Label As String
            Public Overridable Property Tone As String
            Public Overridable Property Kind As String
        End Class

        Public Partial Class FormSubmissionSearchRequest
            Public Overridable Property FormUID As Guid?
            Public Overridable Property Mode As String
            Public Overridable Property Forms As List(Of Guid) = New List(Of Guid)
            Public Overridable Property Stages As List(Of String) = New List(Of String)
            Public Overridable Property Assignees As List(Of Integer) = New List(Of Integer)
            Public Overridable Property Branches As List(Of String) = New List(Of String)
            Public Overridable Property Tags As List(Of String) = New List(Of String)
            Public Overridable Property Search As String
            Public Overridable Property SortKey As String
            Public Overridable Property SortDir As Integer
            Public Overridable Property Skip As Integer
            Public Overridable Property Take As Integer
            Public Overridable Property Conds As List(Of FormAnswerCond) = New List(Of FormAnswerCond)
        End Class

        Public Partial Class FormSubmissionSearchResponse
            Public Overridable Property Rows As List(Of FormInboxRow) = New List(Of FormInboxRow)
            Public Overridable Property Matching As Integer
            Public Overridable Property ScopeTotal As Integer
            Public Overridable Property StageMatching As List(Of FormInboxCount) = New List(Of FormInboxCount)
            Public Overridable Property Counts As FormInboxCounts
            Public Overridable Property Stages As List(Of FormStageInfo) = New List(Of FormStageInfo)
            Public Overridable Property Capped As Boolean
            Public Overridable Property FilterFields As List(Of FormFilterField) = New List(Of FormFilterField)
            Public Overridable Property TagOptions As List(Of String) = New List(Of String)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}