Trendsic Platform Service

<back to all web services

FormStartersRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/starters
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 FormStarter:
    template_u_i_d: Optional[str] = None
    name: Optional[str] = None
    noun: Optional[str] = None
    number_prefix: Optional[str] = None
    description: Optional[str] = None
    pack: Optional[str] = None
    pack_name: Optional[str] = None
    is_tenant_template: bool = False
    payload_json: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormStartersResponse:
    starters: List[FormStarter] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormStartersRequest:
    pass

Python FormStartersRequest 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/starters HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Starters: 
	[
		{
			TemplateUID: 00000000000000000000000000000000,
			Name: String,
			Noun: String,
			NumberPrefix: String,
			Description: String,
			Pack: String,
			PackName: String,
			IsTenantTemplate: False,
			PayloadJson: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}