| POST | /v1/forms/submissions/{SubmissionUID}/notes |
|---|
import Foundation
import ServiceStack
public class FormSubmissionNoteRequest : Codable
{
public var submissionUID:String
public var text:String
required public init(){}
}
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] = []
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
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(){}
}
Swift FormSubmissionNoteRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/forms/submissions/{SubmissionUID}/notes HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SubmissionUID: 00000000000000000000000000000000,
Text: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
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-01,
Dot: String
}
],
Notes:
[
{
Who: String,
X: String,
T: String,
At: 0001-01-01,
Dot: String
}
],
Audit:
[
{
Who: String,
X: String,
T: String,
At: 0001-01-01,
Dot: String
}
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}