Trendsic Platform Service

<back to all web services

FormReadinessRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/readiness
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 FormReadinessCheck:
    level: Optional[str] = None
    text: Optional[str] = None
    fix_tab: Optional[str] = None
    fix_field_key: Optional[str] = None
    fix_label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormReadinessResponse:
    checks: List[FormReadinessCheck] = field(default_factory=list)
    changes: List[str] = field(default_factory=list)
    next_version: int = 0
    is_first_publish: bool = False
    nothing_changed: bool = False
    can_publish: bool = False
    draft_rev: int = 0
    response_status: Optional[ResponseStatus] = None


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

Python FormReadinessRequest DTOs

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

HTTP + CSV

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

GET /v1/forms/{FormUID}/readiness HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Checks":[{"Level":"String","Text":"String","FixTab":"String","FixFieldKey":"String","FixLabel":"String"}],"Changes":["String"],"NextVersion":0,"IsFirstPublish":false,"NothingChanged":false,"CanPublish":false,"DraftRev":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}