Trendsic Platform Service

FormReadinessRequest

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormReadinessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanPublish>false</CanPublish>
  <Changes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Changes>
  <Checks>
    <FormReadinessCheck>
      <FixFieldKey>String</FixFieldKey>
      <FixLabel>String</FixLabel>
      <FixTab>String</FixTab>
      <Level>String</Level>
      <Text>String</Text>
    </FormReadinessCheck>
  </Checks>
  <DraftRev>0</DraftRev>
  <IsFirstPublish>false</IsFirstPublish>
  <NextVersion>0</NextVersion>
  <NothingChanged>false</NothingChanged>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FormReadinessResponse>