Trendsic Platform Service

<back to all web services

FormFillWithdrawRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/withdraw
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillStage:
    id: Optional[str] = None
    label: Optional[str] = None
    tone: Optional[str] = None
    kind: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillStageSeen:
    id: Optional[str] = None
    at: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillReceiptLine:
    channel: Optional[str] = None
    to: Optional[str] = None
    outcome: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillStatusResponse:
    number: Optional[str] = None
    form_name: Optional[str] = None
    noun: Optional[str] = None
    tenant_name: Optional[str] = None
    stage: Optional[str] = None
    stage_kind: Optional[str] = None
    stages: List[FormFillStage] = field(default_factory=list)
    seen: List[FormFillStageSeen] = field(default_factory=list)
    submitted_at: Optional[datetime.datetime] = None
    receipt: List[FormFillReceiptLine] = field(default_factory=list)
    can_withdraw: bool = False
    lang: Optional[str] = None
    noun_es: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillWithdrawRequest:
    token: Optional[str] = None

Python 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
		}
	}
}