| POST | /v1/forms/submissions/{SubmissionUID}/assign |
|---|
"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}} [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;
}
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 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[]}} [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 = [];
}
export class FormSubmissionRecordResponse {
/** @param {{Record?:FormSubmissionRecord,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FormSubmissionRecord} */
Record;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormSubmissionAssignRequest {
/** @param {{SubmissionUID?:string,AgentId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SubmissionUID;
/** @type {?number} */
AgentId;
}
JavaScript FormSubmissionAssignRequest 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}/assign HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionAssignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentId>0</AgentId>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionAssignRequest>
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>