Trendsic Platform Service

<back to all web services

FormDraftRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/forms/{FormUID}/draft
"use strict";
export class FormDraftResponse {
    /** @param {{DraftRev?:number,DraftDirty?:boolean,Warnings?:string[],AlwaysHidden?:string[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DraftRev;
    /** @type {boolean} */
    DraftDirty;
    /** @type {string[]} */
    Warnings = [];
    /** @type {string[]} */
    AlwaysHidden = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormDraftRequest {
    /** @param {{FormUID?:string,DraftJson?:string,DraftRev?:number,SettingsJson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
    /** @type {string} */
    DraftJson;
    /** @type {number} */
    DraftRev;
    /** @type {string} */
    SettingsJson;
}

JavaScript FormDraftRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/forms/{FormUID}/draft HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormDraftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DraftJson>String</DraftJson>
  <DraftRev>0</DraftRev>
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <SettingsJson>String</SettingsJson>
</FormDraftRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormDraftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AlwaysHidden xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AlwaysHidden>
  <DraftDirty>false</DraftDirty>
  <DraftRev>0</DraftRev>
  <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>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Warnings>
</FormDraftResponse>