Trendsic Platform Service

<back to all web services

FormSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/settings

export class FormReadinessCheck
{
    public Level: string;
    public Text: string;
    public FixTab: string;
    public FixFieldKey: string;
    public FixLabel: string;

    public constructor(init?: Partial<FormReadinessCheck>) { (Object as any).assign(this, init); }
}

export class FormSettingsResponse
{
    public SettingsJson: string;
    public SettingsRev: number;
    public Link: string;
    public LinkPaused: string;
    public OfferChecks: FormReadinessCheck[] = [];
    public DraftsInProgress: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormSettingsResponse>) { (Object as any).assign(this, init); }
}

export class FormSettingsRequest
{
    public FormUID: string;

    public constructor(init?: Partial<FormSettingsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}