Trendsic Platform Service

<back to all web services

FormFillSignRequest

The following routes are available for this service:
POST/v1/formfill/draft/{Token}/sign/{FieldKey}
"use strict";
export class FormFillFieldError {
    /** @param {{K?:string,Msg?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    K;
    /** @type {string} */
    Msg;
}
export class FormFillSignResponse {
    /** @param {{Mode?:string,Name?:string,At?:string,Id?:string,Hash?:string,Rev?:number,Errors?:FormFillFieldError[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Mode;
    /** @type {string} */
    Name;
    /** @type {string} */
    At;
    /** @type {string} */
    Id;
    /** @type {string} */
    Hash;
    /** @type {number} */
    Rev;
    /** @type {FormFillFieldError[]} */
    Errors = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormFillSignRequest {
    /** @param {{Token?:string,FieldKey?:string,AnswersJson?:string,Page?:number,Lang?:string,Rev?:number,Mode?:string,Name?:string,Png?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    FieldKey;
    /** @type {string} */
    AnswersJson;
    /** @type {number} */
    Page;
    /** @type {string} */
    Lang;
    /** @type {?number} */
    Rev;
    /** @type {string} */
    Mode;
    /** @type {string} */
    Name;
    /** @type {string} */
    Png;
}

JavaScript FormFillSignRequest DTOs

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

HTTP + JSV

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

POST /v1/formfill/draft/{Token}/sign/{FieldKey} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	FieldKey: String,
	AnswersJson: String,
	Page: 0,
	Lang: String,
	Rev: 0,
	Mode: String,
	Name: String,
	Png: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Mode: String,
	Name: String,
	At: String,
	Id: String,
	Hash: String,
	Rev: 0,
	Errors: 
	[
		{
			K: String,
			Msg: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}