Trendsic Platform Service

<back to all web services

FormSubmissionDecidePreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/decide/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 FormDecisionChoice:
    id: Optional[str] = None
    label: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormDecisionPlan:
    who: Optional[str] = None
    stage: Optional[str] = None
    choices: List[FormDecisionChoice] = field(default_factory=list)
    outcome: Optional[str] = None
    reasons: List[str] = field(default_factory=list)
    reason: Optional[str] = None
    need_sig: bool = False
    signer_name: Optional[str] = None
    signer_refusal: Optional[str] = None
    effects: List[FormDecisionEffect] = field(default_factory=list)
    block: Optional[str] = None
    go_label: Optional[str] = None
    go_cls: Optional[str] = None
    can_decide: bool = False
    refusal: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionDecidePreviewRequest:
    submission_u_i_d: Optional[str] = None
    outcome: Optional[str] = None
    reason: Optional[str] = None
    note: Optional[str] = None

Python FormSubmissionDecidePreviewRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/forms/submissions/{SubmissionUID}/decide/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Outcome":"String","Reason":"String","Note":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Plan":{"Who":"String","Stage":"String","Choices":[{"Id":"String","Label":"String"}],"Outcome":"String","Reasons":["String"],"Reason":"String","NeedSig":false,"SignerName":"String","SignerRefusal":"String","Effects":[{"Kind":"String","Text":"String","Tone":"String"}],"Block":"String","GoLabel":"String","GoCls":"String","CanDecide":false,"Refusal":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}