Trendsic Platform Service

<back to all web services

FormFillStartRequest

The following routes are available for this service:
POST/v1/formfill/{TenantSlug}/{FormSlug}/start
"use strict";
export class FormFillStartResponse {
    /** @param {{Token?:string,Rev?:number,StatusUrl?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {number} */
    Rev;
    /** @type {string} */
    StatusUrl;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormFillStartRequest {
    /** @param {{TenantSlug?:string,FormSlug?:string,TurnstileToken?:string,Invite?:string,Lang?:string,Params?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TenantSlug;
    /** @type {string} */
    FormSlug;
    /** @type {string} */
    TurnstileToken;
    /** @type {string} */
    Invite;
    /** @type {string} */
    Lang;
    /** @type {{ [index:string]: string; }} */
    Params = {};
}

JavaScript FormFillStartRequest 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.

POST /v1/formfill/{TenantSlug}/{FormSlug}/start HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormFillStartRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FormSlug>String</FormSlug>
  <Invite>String</Invite>
  <Lang>String</Lang>
  <Params xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Params>
  <TenantSlug>String</TenantSlug>
  <TurnstileToken>String</TurnstileToken>
</FormFillStartRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormFillStartResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Rev>0</Rev>
  <StatusUrl>String</StatusUrl>
  <Token>String</Token>
</FormFillStartResponse>