Trendsic Platform Service

<back to all web services

FormSubmissionStageRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/stage
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 FormPerson
            Public Overridable Property AgentId As Integer
            Public Overridable Property AgentName As String
        End Class

        Public Partial Class FormRecordComputed
            Public Overridable Property L As String
            Public Overridable Property V As String
        End Class

        Public Partial Class FormRecordDoc
            Public Overridable Property Name As String
            Public Overridable Property Ok As Boolean
            Public Overridable Property Tag As String
            Public Overridable Property Tone As String
        End Class

        Public Partial Class FormRecordEvent
            Public Overridable Property Who As String
            Public Overridable Property X As String
            Public Overridable Property T As String
            Public Overridable Property At As Date
            Public Overridable Property Dot As String
        End Class

        Public Partial Class FormRecordFile
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Kind As String
            Public Overridable Property Size As String
            Public Overridable Property Sensitive As Boolean
            Public Overridable Property Locked As Boolean
        End Class

        Public Partial Class FormRecordRow
            Public Overridable Property K As String
            Public Overridable Property L As String
            Public Overridable Property T As String
            Public Overridable Property Kind As String
            Public Overridable Property V As String
            Public Overridable Property Sensitive As Boolean
            Public Overridable Property CanReveal As Boolean
            Public Overridable Property Locked As Boolean
            Public Overridable Property Files As List(Of FormRecordFile) = New List(Of FormRecordFile)
            Public Overridable Property NoFiles As Boolean
            Public Overridable Property Sig As FormRecordSig
        End Class

        Public Partial Class FormRecordSection
            Public Overridable Property Title As String
            Public Overridable Property Rows As List(Of FormRecordRow) = New List(Of FormRecordRow)
        End Class

        Public Partial Class FormRecordSig
            Public Overridable Property Pending As Boolean
            Public Overridable Property Mode As String
            Public Overridable Property SignerName As String
            Public Overridable Property Role As String
            Public Overridable Property RecordId As Integer
            Public Overridable Property ImageHash As String
            Public Overridable Property DocumentDigest As String
            Public Overridable Property Ip As String
            Public Overridable Property Browser As String
            Public Overridable Property ConsentStored As Boolean
            Public Overridable Property SignedText As String
            Public Overridable Property HasImage As Boolean
        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 FormSubmissionRecord
            Public Overridable Property SubmissionUID As Guid
            Public Overridable Property FormUID As Guid
            Public Overridable Property FormName As String
            Public Overridable Property Noun As String
            Public Overridable Property Number As String
            Public Overridable Property ApplicantName As String
            Public Overridable Property Stage As FormStageInfo
            Public Overridable Property Tags As List(Of String) = New List(Of 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 VersionNo As Integer
            Public Overridable Property CurrentVersionNo As Integer
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
            Public Overridable Property ContactName As String
            Public Overridable Property Meta As String
            Public Overridable Property Stages As List(Of FormStageInfo) = New List(Of FormStageInfo)
            Public Overridable Property Moves As List(Of FormStageInfo) = New List(Of FormStageInfo)
            Public Overridable Property People As List(Of FormPerson) = New List(Of FormPerson)
            Public Overridable Property CanEdit As Boolean
            Public Overridable Property CanSensitive As Boolean
            Public Overridable Property Sections As List(Of FormRecordSection) = New List(Of FormRecordSection)
            Public Overridable Property Docs As List(Of FormRecordDoc) = New List(Of FormRecordDoc)
            Public Overridable Property DocCount As String
            Public Overridable Property Computed As List(Of FormRecordComputed) = New List(Of FormRecordComputed)
            Public Overridable Property Timeline As List(Of FormRecordEvent) = New List(Of FormRecordEvent)
            Public Overridable Property Notes As List(Of FormRecordEvent) = New List(Of FormRecordEvent)
            Public Overridable Property Audit As List(Of FormRecordEvent) = New List(Of FormRecordEvent)
        End Class

        Public Partial Class FormSubmissionRecordResponse
            Public Overridable Property Record As FormSubmissionRecord
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class FormSubmissionStageRequest
            Public Overridable Property SubmissionUID As Guid
            Public Overridable Property Stage As String
            Public Overridable Property From As String
        End Class
    End Namespace
End Namespace

VB.NET FormSubmissionStageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/forms/submissions/{SubmissionUID}/stage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Stage":"String","From":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Record":{"SubmissionUID":"00000000000000000000000000000000","FormUID":"00000000000000000000000000000000","FormName":"String","Noun":"String","Number":"String","ApplicantName":"String","Stage":{"Id":"String","Label":"String","Tone":"String","Kind":"String"},"Tags":["String"],"AssigneeAgentId":0,"AssigneeName":"String","BranchName":"String","SubmittedAt":"0001-01-01T00:00:00.0000000","VersionNo":0,"CurrentVersionNo":0,"Email":"String","Phone":"String","ContactName":"String","Meta":"String","Stages":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"Moves":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"People":[{"AgentId":0,"AgentName":"String"}],"CanEdit":false,"CanSensitive":false,"Sections":[{"Title":"String","Rows":[{"K":"String","L":"String","T":"String","Kind":"String","V":"String","Sensitive":false,"CanReveal":false,"Locked":false,"Files":[{"AttachmentId":"00000000000000000000000000000000","Name":"String","Kind":"String","Size":"String","Sensitive":false,"Locked":false}],"NoFiles":false,"Sig":{"Pending":false,"Mode":"String","SignerName":"String","Role":"String","RecordId":0,"ImageHash":"String","DocumentDigest":"String","Ip":"String","Browser":"String","ConsentStored":false,"SignedText":"String","HasImage":false}}]}],"Docs":[{"Name":"String","Ok":false,"Tag":"String","Tone":"String"}],"DocCount":"String","Computed":[{"L":"String","V":"String"}],"Timeline":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}],"Notes":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}],"Audit":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}