| POST | /v1/forms/submissions/{SubmissionUID}/request-info |
|---|
"use strict";
export class FormStageInfo {
/** @param {{Id?:string,Label?:string,Tone?:string,Kind?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Label;
/** @type {string} */
Tone;
/** @type {string} */
Kind;
}
export class FormPerson {
/** @param {{AgentId?:number,AgentName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentId;
/** @type {string} */
AgentName;
}
export class FormRecordFile {
/** @param {{AttachmentId?:string,Name?:string,Kind?:string,Size?:string,Sensitive?:boolean,Locked?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AttachmentId;
/** @type {string} */
Name;
/** @type {string} */
Kind;
/** @type {string} */
Size;
/** @type {boolean} */
Sensitive;
/** @type {boolean} */
Locked;
}
export class FormRecordSig {
/** @param {{Pending?:boolean,Mode?:string,SignerName?:string,Role?:string,RecordId?:number,ImageHash?:string,DocumentDigest?:string,Ip?:string,Browser?:string,ConsentStored?:boolean,SignedText?:string,HasImage?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Pending;
/** @type {string} */
Mode;
/** @type {string} */
SignerName;
/** @type {string} */
Role;
/** @type {number} */
RecordId;
/** @type {string} */
ImageHash;
/** @type {string} */
DocumentDigest;
/** @type {string} */
Ip;
/** @type {string} */
Browser;
/** @type {boolean} */
ConsentStored;
/** @type {string} */
SignedText;
/** @type {boolean} */
HasImage;
}
export class FormRecordRow {
/** @param {{K?:string,L?:string,T?:string,Kind?:string,V?:string,Sensitive?:boolean,CanReveal?:boolean,Locked?:boolean,Files?:FormRecordFile[],NoFiles?:boolean,Sig?:FormRecordSig,Asked?:boolean,Changed?:boolean,Prev?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
K;
/** @type {string} */
L;
/** @type {string} */
T;
/** @type {string} */
Kind;
/** @type {string} */
V;
/** @type {boolean} */
Sensitive;
/** @type {boolean} */
CanReveal;
/** @type {boolean} */
Locked;
/** @type {FormRecordFile[]} */
Files = [];
/** @type {boolean} */
NoFiles;
/** @type {FormRecordSig} */
Sig;
/** @type {boolean} */
Asked;
/** @type {boolean} */
Changed;
/** @type {string} */
Prev;
}
export class FormRecordSection {
/** @param {{Title?:string,Rows?:FormRecordRow[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Title;
/** @type {FormRecordRow[]} */
Rows = [];
}
export class FormRecordDoc {
/** @param {{Name?:string,Ok?:boolean,Tag?:string,Tone?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {boolean} */
Ok;
/** @type {string} */
Tag;
/** @type {string} */
Tone;
}
export class FormRecordComputed {
/** @param {{L?:string,V?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
L;
/** @type {string} */
V;
}
export class FormRecordEvent {
/** @param {{Who?:string,X?:string,T?:string,At?:string,Dot?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Who;
/** @type {string} */
X;
/** @type {string} */
T;
/** @type {string} */
At;
/** @type {string} */
Dot;
}
export class FormRecordRequest {
/** @param {{RequestUID?:string,Keys?:string[],Resign?:string[],Note?:string,By?:string,At?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RequestUID;
/** @type {string[]} */
Keys = [];
/** @type {string[]} */
Resign = [];
/** @type {string} */
Note;
/** @type {string} */
By;
/** @type {string} */
At;
}
export class FormRecordDecision {
/** @param {{Outcome?:string,Tone?:string,Reason?:string,Note?:string,Text?:string,HasCounter?:boolean,Typed?:boolean,Drawn?:boolean,SigName?:string,SigMeta?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Outcome;
/** @type {string} */
Tone;
/** @type {string} */
Reason;
/** @type {string} */
Note;
/** @type {string} */
Text;
/** @type {boolean} */
HasCounter;
/** @type {boolean} */
Typed;
/** @type {boolean} */
Drawn;
/** @type {string} */
SigName;
/** @type {string} */
SigMeta;
}
export class FormRecordEarlierDecision {
/** @param {{Outcome?:string,Tone?:string,Reason?:string,Note?:string,Text?:string,Counter?:string,Reopened?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Outcome;
/** @type {string} */
Tone;
/** @type {string} */
Reason;
/** @type {string} */
Note;
/** @type {string} */
Text;
/** @type {string} */
Counter;
/** @type {string} */
Reopened;
}
export class FormRecordSigEntry {
/** @param {{RecordId?:number,Key?:string,Label?:string,Role?:string,SignerName?:string,Mode?:string,HasImage?:boolean,ConsentStored?:boolean,Replaced?:boolean,Counter?:boolean,Reopened?:boolean,Meta?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RecordId;
/** @type {string} */
Key;
/** @type {string} */
Label;
/** @type {string} */
Role;
/** @type {string} */
SignerName;
/** @type {string} */
Mode;
/** @type {boolean} */
HasImage;
/** @type {boolean} */
ConsentStored;
/** @type {boolean} */
Replaced;
/** @type {boolean} */
Counter;
/** @type {boolean} */
Reopened;
/** @type {string} */
Meta;
}
export class FormRecordReplacedRow {
/** @param {{K?:string,L?:string,Kind?:string,V?:string,Sensitive?:boolean,CanReveal?:boolean,Locked?:boolean,Files?:FormRecordFile[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
K;
/** @type {string} */
L;
/** @type {string} */
Kind;
/** @type {string} */
V;
/** @type {boolean} */
Sensitive;
/** @type {boolean} */
CanReveal;
/** @type {boolean} */
Locked;
/** @type {FormRecordFile[]} */
Files = [];
}
export class FormRecordReplaced {
/** @param {{RequestUID?:string,AskedBy?:string,AskedAt?:string,AnsweredAt?:string,Covering?:string,Rows?:FormRecordReplacedRow[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RequestUID;
/** @type {string} */
AskedBy;
/** @type {string} */
AskedAt;
/** @type {string} */
AnsweredAt;
/** @type {string} */
Covering;
/** @type {FormRecordReplacedRow[]} */
Rows = [];
}
export class FormSubmissionRecord {
/** @param {{SubmissionUID?:string,FormUID?:string,FormName?:string,Noun?:string,Number?:string,ApplicantName?:string,Stage?:FormStageInfo,Tags?:string[],AssigneeAgentId?:number,AssigneeName?:string,BranchName?:string,SubmittedAt?:string,VersionNo?:number,CurrentVersionNo?:number,Email?:string,Phone?:string,ContactName?:string,Meta?:string,Stages?:FormStageInfo[],Moves?:FormStageInfo[],People?:FormPerson[],CanEdit?:boolean,CanSensitive?:boolean,Sections?:FormRecordSection[],Docs?:FormRecordDoc[],DocCount?:string,Computed?:FormRecordComputed[],Timeline?:FormRecordEvent[],Notes?:FormRecordEvent[],Audit?:FormRecordEvent[],IsTest?:boolean,VersionText?:string,TenantName?:string,SubmittedIso?:string,OpenRequest?:FormRecordRequest,CanRequest?:boolean,RequestTip?:string,Decision?:FormRecordDecision,Earlier?:FormRecordEarlierDecision[],CanDecide?:boolean,DecideTip?:string,MoveTip?:string,DueAt?:string,Overdue?:boolean,AgeText?:string,DueText?:string,Signatures?:FormRecordSigEntry[],Replaced?:FormRecordReplaced[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SubmissionUID;
/** @type {string} */
FormUID;
/** @type {string} */
FormName;
/** @type {string} */
Noun;
/** @type {string} */
Number;
/** @type {string} */
ApplicantName;
/** @type {FormStageInfo} */
Stage;
/** @type {string[]} */
Tags = [];
/** @type {?number} */
AssigneeAgentId;
/** @type {string} */
AssigneeName;
/** @type {string} */
BranchName;
/** @type {?string} */
SubmittedAt;
/** @type {number} */
VersionNo;
/** @type {number} */
CurrentVersionNo;
/** @type {string} */
Email;
/** @type {string} */
Phone;
/** @type {string} */
ContactName;
/** @type {string} */
Meta;
/** @type {FormStageInfo[]} */
Stages = [];
/** @type {FormStageInfo[]} */
Moves = [];
/** @type {FormPerson[]} */
People = [];
/** @type {boolean} */
CanEdit;
/** @type {boolean} */
CanSensitive;
/** @type {FormRecordSection[]} */
Sections = [];
/** @type {FormRecordDoc[]} */
Docs = [];
/** @type {string} */
DocCount;
/** @type {FormRecordComputed[]} */
Computed = [];
/** @type {FormRecordEvent[]} */
Timeline = [];
/** @type {FormRecordEvent[]} */
Notes = [];
/** @type {FormRecordEvent[]} */
Audit = [];
/** @type {boolean} */
IsTest;
/** @type {string} */
VersionText;
/** @type {string} */
TenantName;
/** @type {string} */
SubmittedIso;
/** @type {FormRecordRequest} */
OpenRequest;
/** @type {boolean} */
CanRequest;
/** @type {string} */
RequestTip;
/** @type {FormRecordDecision} */
Decision;
/** @type {FormRecordEarlierDecision[]} */
Earlier = [];
/** @type {boolean} */
CanDecide;
/** @type {string} */
DecideTip;
/** @type {string} */
MoveTip;
/** @type {?string} */
DueAt;
/** @type {boolean} */
Overdue;
/** @type {string} */
AgeText;
/** @type {string} */
DueText;
/** @type {FormRecordSigEntry[]} */
Signatures = [];
/** @type {FormRecordReplaced[]} */
Replaced = [];
}
export class FormSubmissionRecordResponse {
/** @param {{Record?:FormSubmissionRecord,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FormSubmissionRecord} */
Record;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormFillReceiptLine {
/** @param {{Channel?:string,To?:string,Outcome?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Channel;
/** @type {string} */
To;
/** @type {string} */
Outcome;
}
export class FormSubmissionRequestInfoResponse extends FormSubmissionRecordResponse {
/** @param {{Sent?:FormFillReceiptLine[],Record?:FormSubmissionRecord,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {FormFillReceiptLine[]} */
Sent = [];
}
export class FormSubmissionRequestInfoRequest {
/** @param {{SubmissionUID?:string,Keys?:string[],Note?:string,From?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SubmissionUID;
/** @type {string[]} */
Keys = [];
/** @type {string} */
Note;
/** @type {string} */
From;
}
JavaScript FormSubmissionRequestInfoRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"SubmissionUID":"00000000000000000000000000000000","Keys":["String"],"Note":"String","From":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Sent":[{"Channel":"String","To":"String","Outcome":"String"}],"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},"Asked":false,"Changed":false,"Prev":"String"}]}],"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"}],"IsTest":false,"VersionText":"String","TenantName":"String","SubmittedIso":"String","OpenRequest":{"RequestUID":"00000000000000000000000000000000","Keys":["String"],"Resign":["String"],"Note":"String","By":"String","At":"String"},"CanRequest":false,"RequestTip":"String","Decision":{"Outcome":"String","Tone":"String","Reason":"String","Note":"String","Text":"String","HasCounter":false,"Typed":false,"Drawn":false,"SigName":"String","SigMeta":"String"},"Earlier":[{"Outcome":"String","Tone":"String","Reason":"String","Note":"String","Text":"String","Counter":"String","Reopened":"String"}],"CanDecide":false,"DecideTip":"String","MoveTip":"String","DueAt":"0001-01-01T00:00:00.0000000","Overdue":false,"AgeText":"String","DueText":"String","Signatures":[{"RecordId":0,"Key":"String","Label":"String","Role":"String","SignerName":"String","Mode":"String","HasImage":false,"ConsentStored":false,"Replaced":false,"Counter":false,"Reopened":false,"Meta":"String"}],"Replaced":[{"RequestUID":"00000000000000000000000000000000","AskedBy":"String","AskedAt":"String","AnsweredAt":"String","Covering":"String","Rows":[{"K":"String","L":"String","Kind":"String","V":"String","Sensitive":false,"CanReveal":false,"Locked":false,"Files":[{"AttachmentId":"00000000000000000000000000000000","Name":"String","Kind":"String","Size":"String","Sensitive":false,"Locked":false}]}]}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}