Trendsic Platform Service

<back to all web services

FormSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/settings
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 FormSettingsResponse:
    settings_json: Optional[str] = None
    settings_rev: int = 0
    link: Optional[str] = None
    link_paused: Optional[str] = None
    offer_checks: List[FormReadinessCheck] = field(default_factory=list)
    drafts_in_progress: int = 0
    response_status: Optional[ResponseStatus] = None


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

Python FormSettingsRequest 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.

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

{
	SettingsJson: String,
	SettingsRev: 0,
	Link: String,
	LinkPaused: String,
	OfferChecks: 
	[
		{
			Level: String,
			Text: String,
			FixTab: String,
			FixFieldKey: String,
			FixLabel: String
		}
	],
	DraftsInProgress: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}