| POST | /v1/forms/submissions/{SubmissionUID}/request-info |
|---|
import Foundation
import ServiceStack
public class FormSubmissionRequestInfoRequest : Codable
{
public var submissionUID:String
public var keys:[String] = []
public var note:String
public var from:String
required public init(){}
}
public class FormSubmissionRequestInfoResponse : FormSubmissionRecordResponse
{
public var sent:[FormFillReceiptLine] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case sent
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
sent = try container.decodeIfPresent([FormFillReceiptLine].self, forKey: .sent) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if sent.count > 0 { try container.encode(sent, forKey: .sent) }
}
}
public class FormSubmissionRecordResponse : Codable
{
public var record:FormSubmissionRecord
public var responseStatus:ResponseStatus
required public init(){}
}
public class FormSubmissionRecord : Codable
{
public var submissionUID:String
public var formUID:String
public var formName:String
public var noun:String
public var number:String
public var applicantName:String
public var stage:FormStageInfo
public var tags:[String] = []
public var assigneeAgentId:Int?
public var assigneeName:String
public var branchName:String
public var submittedAt:Date?
public var versionNo:Int
public var currentVersionNo:Int
public var email:String
public var phone:String
public var contactName:String
public var meta:String
public var stages:[FormStageInfo] = []
public var moves:[FormStageInfo] = []
public var people:[FormPerson] = []
public var canEdit:Bool
public var canSensitive:Bool
public var sections:[FormRecordSection] = []
public var docs:[FormRecordDoc] = []
public var docCount:String
public var computed:[FormRecordComputed] = []
public var timeline:[FormRecordEvent] = []
public var notes:[FormRecordEvent] = []
public var audit:[FormRecordEvent] = []
public var isTest:Bool
public var versionText:String
public var tenantName:String
public var submittedIso:String
public var openRequest:FormRecordRequest
public var canRequest:Bool
public var requestTip:String
public var decision:FormRecordDecision
public var earlier:[FormRecordEarlierDecision] = []
public var canDecide:Bool
public var decideTip:String
public var moveTip:String
public var dueAt:Date?
public var overdue:Bool
public var ageText:String
public var dueText:String
public var signatures:[FormRecordSigEntry] = []
public var replaced:[FormRecordReplaced] = []
required public init(){}
}
public class FormStageInfo : Codable
{
public var id:String
public var label:String
public var tone:String
public var kind:String
required public init(){}
}
public class FormPerson : Codable
{
public var agentId:Int
public var agentName:String
required public init(){}
}
public class FormRecordSection : Codable
{
public var title:String
public var rows:[FormRecordRow] = []
required public init(){}
}
public class FormRecordRow : Codable
{
public var k:String
public var l:String
public var t:String
public var kind:String
public var v:String
public var sensitive:Bool
public var canReveal:Bool
public var locked:Bool
public var files:[FormRecordFile] = []
public var noFiles:Bool
public var sig:FormRecordSig
public var asked:Bool
public var changed:Bool
public var prev:String
required public init(){}
}
public class FormRecordFile : Codable
{
public var attachmentId:String
public var name:String
public var kind:String
public var size:String
public var sensitive:Bool
public var locked:Bool
required public init(){}
}
public class FormRecordSig : Codable
{
public var pending:Bool
public var mode:String
public var signerName:String
public var role:String
public var recordId:Int
public var imageHash:String
public var documentDigest:String
public var ip:String
public var browser:String
public var consentStored:Bool
public var signedText:String
public var hasImage:Bool
required public init(){}
}
public class FormRecordDoc : Codable
{
public var name:String
public var ok:Bool
public var tag:String
public var tone:String
required public init(){}
}
public class FormRecordComputed : Codable
{
public var l:String
public var v:String
required public init(){}
}
public class FormRecordEvent : Codable
{
public var who:String
public var x:String
public var t:String
public var at:Date
public var dot:String
required public init(){}
}
public class FormRecordRequest : Codable
{
public var requestUID:String
public var keys:[String] = []
public var resign:[String] = []
public var note:String
public var by:String
public var at:String
required public init(){}
}
public class FormRecordDecision : Codable
{
public var outcome:String
public var tone:String
public var reason:String
public var note:String
public var text:String
public var hasCounter:Bool
public var typed:Bool
public var drawn:Bool
public var sigName:String
public var sigMeta:String
required public init(){}
}
public class FormRecordEarlierDecision : Codable
{
public var outcome:String
public var tone:String
public var reason:String
public var note:String
public var text:String
public var counter:String
public var reopened:String
required public init(){}
}
public class FormRecordSigEntry : Codable
{
public var recordId:Int
public var key:String
public var label:String
public var role:String
public var signerName:String
public var mode:String
public var hasImage:Bool
public var consentStored:Bool
public var replaced:Bool
public var counter:Bool
public var reopened:Bool
public var meta:String
required public init(){}
}
public class FormRecordReplaced : Codable
{
public var requestUID:String
public var askedBy:String
public var askedAt:String
public var answeredAt:String
public var covering:String
public var rows:[FormRecordReplacedRow] = []
required public init(){}
}
public class FormRecordReplacedRow : Codable
{
public var k:String
public var l:String
public var kind:String
public var v:String
public var sensitive:Bool
public var canReveal:Bool
public var locked:Bool
public var files:[FormRecordFile] = []
required public init(){}
}
public class FormFillReceiptLine : Codable
{
public var channel:String
public var to:String
public var outcome:String
required public init(){}
}
Swift FormSubmissionRequestInfoRequest 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.
POST /v1/forms/submissions/{SubmissionUID}/request-info HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionRequestInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<From>String</From>
<Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Keys>
<Note>String</Note>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionRequestInfoRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionRequestInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Record>
<AgeText>String</AgeText>
<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>
<CanDecide>false</CanDecide>
<CanEdit>false</CanEdit>
<CanRequest>false</CanRequest>
<CanSensitive>false</CanSensitive>
<Computed>
<FormRecordComputed>
<L>String</L>
<V>String</V>
</FormRecordComputed>
</Computed>
<ContactName>String</ContactName>
<CurrentVersionNo>0</CurrentVersionNo>
<DecideTip>String</DecideTip>
<Decision>
<Drawn>false</Drawn>
<HasCounter>false</HasCounter>
<Note>String</Note>
<Outcome>String</Outcome>
<Reason>String</Reason>
<SigMeta>String</SigMeta>
<SigName>String</SigName>
<Text>String</Text>
<Tone>String</Tone>
<Typed>false</Typed>
</Decision>
<DocCount>String</DocCount>
<Docs>
<FormRecordDoc>
<Name>String</Name>
<Ok>false</Ok>
<Tag>String</Tag>
<Tone>String</Tone>
</FormRecordDoc>
</Docs>
<DueAt>0001-01-01T00:00:00</DueAt>
<DueText>String</DueText>
<Earlier>
<FormRecordEarlierDecision>
<Counter>String</Counter>
<Note>String</Note>
<Outcome>String</Outcome>
<Reason>String</Reason>
<Reopened>String</Reopened>
<Text>String</Text>
<Tone>String</Tone>
</FormRecordEarlierDecision>
</Earlier>
<Email>String</Email>
<FormName>String</FormName>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<IsTest>false</IsTest>
<Meta>String</Meta>
<MoveTip>String</MoveTip>
<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>
<OpenRequest>
<At>String</At>
<By>String</By>
<Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Keys>
<Note>String</Note>
<RequestUID>00000000-0000-0000-0000-000000000000</RequestUID>
<Resign xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Resign>
</OpenRequest>
<Overdue>false</Overdue>
<People>
<FormPerson>
<AgentId>0</AgentId>
<AgentName>String</AgentName>
</FormPerson>
</People>
<Phone>String</Phone>
<Replaced>
<FormRecordReplaced>
<AnsweredAt>String</AnsweredAt>
<AskedAt>String</AskedAt>
<AskedBy>String</AskedBy>
<Covering>String</Covering>
<RequestUID>00000000-0000-0000-0000-000000000000</RequestUID>
<Rows>
<FormRecordReplacedRow>
<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>
<Sensitive>false</Sensitive>
<V>String</V>
</FormRecordReplacedRow>
</Rows>
</FormRecordReplaced>
</Replaced>
<RequestTip>String</RequestTip>
<Sections>
<FormRecordSection>
<Rows>
<FormRecordRow>
<Asked>false</Asked>
<CanReveal>false</CanReveal>
<Changed>false</Changed>
<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>
<Prev>String</Prev>
<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>
<Signatures>
<FormRecordSigEntry>
<ConsentStored>false</ConsentStored>
<Counter>false</Counter>
<HasImage>false</HasImage>
<Key>String</Key>
<Label>String</Label>
<Meta>String</Meta>
<Mode>String</Mode>
<RecordId>0</RecordId>
<Reopened>false</Reopened>
<Replaced>false</Replaced>
<Role>String</Role>
<SignerName>String</SignerName>
</FormRecordSigEntry>
</Signatures>
<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>
<SubmittedIso>String</SubmittedIso>
<Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Tags>
<TenantName>String</TenantName>
<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>
<VersionText>String</VersionText>
</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>
<Sent>
<FormFillReceiptLine>
<Channel>String</Channel>
<Outcome>String</Outcome>
<To>String</To>
</FormFillReceiptLine>
</Sent>
</FormSubmissionRequestInfoResponse>