| GET | /v1/forms/submissions/{SubmissionUID} |
|---|
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 FormSubmissionRecordRequest
Public Overridable Property SubmissionUID As Guid
End Class
Public Partial Class FormSubmissionRecordResponse
Public Overridable Property Record As FormSubmissionRecord
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET FormSubmissionRecordRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/forms/submissions/{SubmissionUID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Record>
<ApplicantName>String</ApplicantName>
<AssigneeAgentId>0</AssigneeAgentId>
<AssigneeName>String</AssigneeName>
<Audit>
<FormRecordEvent>
<At>0001-01-01T00:00:00</At>
<Dot>String</Dot>
<T>String</T>
<Who>String</Who>
<X>String</X>
</FormRecordEvent>
</Audit>
<BranchName>String</BranchName>
<CanEdit>false</CanEdit>
<CanSensitive>false</CanSensitive>
<Computed>
<FormRecordComputed>
<L>String</L>
<V>String</V>
</FormRecordComputed>
</Computed>
<ContactName>String</ContactName>
<CurrentVersionNo>0</CurrentVersionNo>
<DocCount>String</DocCount>
<Docs>
<FormRecordDoc>
<Name>String</Name>
<Ok>false</Ok>
<Tag>String</Tag>
<Tone>String</Tone>
</FormRecordDoc>
</Docs>
<Email>String</Email>
<FormName>String</FormName>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Meta>String</Meta>
<Moves>
<FormStageInfo>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</FormStageInfo>
</Moves>
<Notes>
<FormRecordEvent>
<At>0001-01-01T00:00:00</At>
<Dot>String</Dot>
<T>String</T>
<Who>String</Who>
<X>String</X>
</FormRecordEvent>
</Notes>
<Noun>String</Noun>
<Number>String</Number>
<People>
<FormPerson>
<AgentId>0</AgentId>
<AgentName>String</AgentName>
</FormPerson>
</People>
<Phone>String</Phone>
<Sections>
<FormRecordSection>
<Rows>
<FormRecordRow>
<CanReveal>false</CanReveal>
<Files>
<FormRecordFile>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<Kind>String</Kind>
<Locked>false</Locked>
<Name>String</Name>
<Sensitive>false</Sensitive>
<Size>String</Size>
</FormRecordFile>
</Files>
<K>String</K>
<Kind>String</Kind>
<L>String</L>
<Locked>false</Locked>
<NoFiles>false</NoFiles>
<Sensitive>false</Sensitive>
<Sig>
<Browser>String</Browser>
<ConsentStored>false</ConsentStored>
<DocumentDigest>String</DocumentDigest>
<HasImage>false</HasImage>
<ImageHash>String</ImageHash>
<Ip>String</Ip>
<Mode>String</Mode>
<Pending>false</Pending>
<RecordId>0</RecordId>
<Role>String</Role>
<SignedText>String</SignedText>
<SignerName>String</SignerName>
</Sig>
<T>String</T>
<V>String</V>
</FormRecordRow>
</Rows>
<Title>String</Title>
</FormRecordSection>
</Sections>
<Stage>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</Stage>
<Stages>
<FormStageInfo>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</FormStageInfo>
</Stages>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
<SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
<Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Tags>
<Timeline>
<FormRecordEvent>
<At>0001-01-01T00:00:00</At>
<Dot>String</Dot>
<T>String</T>
<Who>String</Who>
<X>String</X>
</FormRecordEvent>
</Timeline>
<VersionNo>0</VersionNo>
</Record>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</FormSubmissionRecordResponse>