Trendsic Platform Service

<back to all web services

FormFillWithdrawRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/withdraw

export class FormFillStage
{
    public Id: string;
    public Label: string;
    public Tone: string;
    public Kind: string;

    public constructor(init?: Partial<FormFillStage>) { (Object as any).assign(this, init); }
}

export class FormFillStageSeen
{
    public Id: string;
    public At: string;

    public constructor(init?: Partial<FormFillStageSeen>) { (Object as any).assign(this, init); }
}

export class FormFillReceiptLine
{
    public Channel: string;
    public To: string;
    public Outcome: string;

    public constructor(init?: Partial<FormFillReceiptLine>) { (Object as any).assign(this, init); }
}

export class FormFillStatusResponse
{
    public Number: string;
    public FormName: string;
    public Noun: string;
    public TenantName: string;
    public Stage: string;
    public StageKind: string;
    public Stages: FormFillStage[] = [];
    public Seen: FormFillStageSeen[] = [];
    public SubmittedAt?: string;
    public Receipt: FormFillReceiptLine[] = [];
    public CanWithdraw: boolean;
    public Lang: string;
    public NounEs: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormFillStatusResponse>) { (Object as any).assign(this, init); }
}

export class FormFillWithdrawRequest
{
    public Token: string;

    public constructor(init?: Partial<FormFillWithdrawRequest>) { (Object as any).assign(this, init); }
}

TypeScript FormFillWithdrawRequest 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/status/{Token}/withdraw HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Number: String,
	FormName: String,
	Noun: String,
	TenantName: String,
	Stage: String,
	StageKind: String,
	Stages: 
	[
		{
			Id: String,
			Label: String,
			Tone: String,
			Kind: String
		}
	],
	Seen: 
	[
		{
			Id: String,
			At: 0001-01-01
		}
	],
	SubmittedAt: 0001-01-01,
	Receipt: 
	[
		{
			Channel: String,
			To: String,
			Outcome: String
		}
	],
	CanWithdraw: False,
	Lang: String,
	NounEs: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}