Trendsic Platform Service

<back to all web services

FormArchiveRequest

export class FormStats
{
    public Total: number;
    public NeedDecision: number;
    public Waiting: number;
    public Overdue: number;

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

export class FormCard
{
    public FormUID: string;
    public Name: string;
    public Slug: string;
    public Noun: string;
    public NumberPrefix: string;
    public Description: string;
    public Tone: string;
    public Status: string;
    public PublishedVersionNo?: number;
    public PublishedAt?: string;
    public PublishedBy: string;
    public DraftDirty: boolean;
    public DraftUpdatedAt?: string;
    public DraftUpdatedBy: string;
    public PackLabel: string;
    public SettingsJson: string;
    public Stats: FormStats;
    public Offered: string[] = [];
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

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

export class FormDetail extends FormCard
{
    public DraftJson: string;
    public DraftRev: number;
    public SourceTemplateUID?: string;
    public Warnings: string[] = [];
    public AlwaysHidden: string[] = [];

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

export class FormResponse
{
    public Form: FormDetail;
    public ResponseStatus: ResponseStatus;

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

export class FormArchiveRequest
{
    public FormUID: string;

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

TypeScript FormArchiveRequest DTOs

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

{
	FormUID: 00000000000000000000000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Form: 
	{
		DraftJson: String,
		DraftRev: 0,
		SourceTemplateUID: 00000000000000000000000000000000,
		Warnings: 
		[
			String
		],
		AlwaysHidden: 
		[
			String
		],
		FormUID: 00000000000000000000000000000000,
		Name: String,
		Slug: String,
		Noun: String,
		NumberPrefix: String,
		Description: String,
		Tone: String,
		Status: String,
		PublishedVersionNo: 0,
		PublishedAt: 0001-01-01,
		PublishedBy: String,
		DraftDirty: False,
		DraftUpdatedAt: 0001-01-01,
		DraftUpdatedBy: String,
		PackLabel: String,
		SettingsJson: String,
		Stats: 
		{
			Total: 0,
			NeedDecision: 0,
			Waiting: 0,
			Overdue: 0
		},
		Offered: 
		[
			String
		],
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}