| POST | /v1/forms/submissions/{SubmissionUID}/decide/preview |
|---|
"use strict";
export class FormDecisionChoice {
/** @param {{Id?:string,Label?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Label;
}
export class FormDecisionEffect {
/** @param {{Kind?:string,Text?:string,Tone?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Kind;
/** @type {string} */
Text;
/** @type {string} */
Tone;
}
export class FormDecisionPlan {
/** @param {{Who?:string,Stage?:string,Choices?:FormDecisionChoice[],Outcome?:string,Reasons?:string[],Reason?:string,NeedSig?:boolean,SignerName?:string,SignerRefusal?:string,Effects?:FormDecisionEffect[],Block?:string,GoLabel?:string,GoCls?:string,CanDecide?:boolean,Refusal?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Who;
/** @type {string} */
Stage;
/** @type {FormDecisionChoice[]} */
Choices = [];
/** @type {string} */
Outcome;
/** @type {string[]} */
Reasons = [];
/** @type {string} */
Reason;
/** @type {boolean} */
NeedSig;
/** @type {string} */
SignerName;
/** @type {string} */
SignerRefusal;
/** @type {FormDecisionEffect[]} */
Effects = [];
/** @type {string} */
Block;
/** @type {string} */
GoLabel;
/** @type {string} */
GoCls;
/** @type {boolean} */
CanDecide;
/** @type {string} */
Refusal;
}
export class FormSubmissionDecidePreviewResponse {
/** @param {{Plan?:FormDecisionPlan,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FormDecisionPlan} */
Plan;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormSubmissionDecidePreviewRequest {
/** @param {{SubmissionUID?:string,Outcome?:string,Reason?:string,Note?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SubmissionUID;
/** @type {string} */
Outcome;
/** @type {string} */
Reason;
/** @type {string} */
Note;
}
JavaScript FormSubmissionDecidePreviewRequest 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}/decide/preview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionDecidePreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Note>String</Note>
<Outcome>String</Outcome>
<Reason>String</Reason>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionDecidePreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionDecidePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Plan>
<Block>String</Block>
<CanDecide>false</CanDecide>
<Choices>
<FormDecisionChoice>
<Id>String</Id>
<Label>String</Label>
</FormDecisionChoice>
</Choices>
<Effects>
<FormDecisionEffect>
<Kind>String</Kind>
<Text>String</Text>
<Tone>String</Tone>
</FormDecisionEffect>
</Effects>
<GoCls>String</GoCls>
<GoLabel>String</GoLabel>
<NeedSig>false</NeedSig>
<Outcome>String</Outcome>
<Reason>String</Reason>
<Reasons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Reasons>
<Refusal>String</Refusal>
<SignerName>String</SignerName>
<SignerRefusal>String</SignerRefusal>
<Stage>String</Stage>
<Who>String</Who>
</Plan>
<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>
</FormSubmissionDecidePreviewResponse>