Trendsic Platform Service

<back to all web services

FormSubmissionRequestPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info/preview
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 FormRequestItem:
    k: Optional[str] = None
    l: Optional[str] = None
    tag: Optional[str] = None
    tone: Optional[str] = None
    pre: bool = False
    is_signature: bool = False
    is_sensitive: bool = False
    pi: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRequestPlan:
    items: List[FormRequestItem] = field(default_factory=list)
    keys: List[str] = field(default_factory=list)
    resign: List[str] = field(default_factory=list)
    resign_keys: List[str] = field(default_factory=list)
    channels: Optional[str] = None
    stage_label: Optional[str] = None
    consequence: Optional[str] = None
    applicant: Optional[str] = None
    stage: Optional[str] = None
    can_send: bool = False
    refusal: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRequestPreviewResponse:
    plan: Optional[FormRequestPlan] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRequestPreviewRequest:
    submission_u_i_d: Optional[str] = None
    keys: List[str] = field(default_factory=list)

Python FormSubmissionRequestPreviewRequest DTOs

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

HTTP + OTHER

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

POST /v1/forms/submissions/{SubmissionUID}/request-info/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Keys":["String"]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Plan":{"Items":[{"K":"String","L":"String","Tag":"String","Tone":"String","Pre":false,"IsSignature":false,"IsSensitive":false,"Pi":0}],"Keys":["String"],"Resign":["String"],"ResignKeys":["String"],"Channels":"String","StageLabel":"String","Consequence":"String","Applicant":"String","Stage":"String","CanSend":false,"Refusal":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}