| POST | /v1/forms/{FormUID}/notices/preview |
|---|
"use strict";
export class FormInboxCount {
/** @param {{V?:string,L?:string,N?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
V;
/** @type {string} */
L;
/** @type {number} */
N;
}
export class FormNoticePreviewResponse {
/** @param {{Subject?:string,Body?:string,Meta?:string,SubmissionUID?:string,Sample?:boolean,SampleNote?:string,TextLength?:number,Segments?:number,Wide?:boolean,Problems?:string[],Samples?:FormInboxCount[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Subject;
/** @type {string} */
Body;
/** @type {string} */
Meta;
/** @type {string} */
SubmissionUID;
/** @type {boolean} */
Sample;
/** @type {string} */
SampleNote;
/** @type {number} */
TextLength;
/** @type {number} */
Segments;
/** @type {boolean} */
Wide;
/** @type {string[]} */
Problems = [];
/** @type {FormInboxCount[]} */
Samples = [];
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormNoticePreviewRequest {
/** @param {{FormUID?:string,Id?:string,Lang?:string,Channel?:string,Subject?:string,Body?:string,Text?:string,Closing?:string,SubmissionUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FormUID;
/** @type {string} */
Id;
/** @type {string} */
Lang;
/** @type {string} */
Channel;
/** @type {string} */
Subject;
/** @type {string} */
Body;
/** @type {string} */
Text;
/** @type {string} */
Closing;
/** @type {?string} */
SubmissionUID;
}
JavaScript FormNoticePreviewRequest 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/{FormUID}/notices/preview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormNoticePreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Body>String</Body>
<Channel>String</Channel>
<Closing>String</Closing>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Id>String</Id>
<Lang>String</Lang>
<Subject>String</Subject>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
<Text>String</Text>
</FormNoticePreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormNoticePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Body>String</Body>
<Meta>String</Meta>
<Problems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Problems>
<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>
<Sample>false</Sample>
<SampleNote>String</SampleNote>
<Samples>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Samples>
<Segments>0</Segments>
<Subject>String</Subject>
<SubmissionUID>String</SubmissionUID>
<TextLength>0</TextLength>
<Wide>false</Wide>
</FormNoticePreviewResponse>