Trendsic Platform Service

<back to all web services

FormArchiveRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/archive
FormArchiveRequest Parameters:
NameParameterData TypeRequiredDescription
FormUIDpathGuidNo
FormResponse Parameters:
NameParameterData TypeRequiredDescription
FormformFormDetailNo
ResponseStatusformResponseStatusNo
FormDetail Parameters:
NameParameterData TypeRequiredDescription
DraftJsonformstringNo
DraftRevformintNo
SourceTemplateUIDformGuid?No
WarningsformList<string>No
AlwaysHiddenformList<string>No
FormCard Parameters:
NameParameterData TypeRequiredDescription
FormUIDformGuidNo
NameformstringNo
SlugformstringNo
NounformstringNo
NumberPrefixformstringNo
DescriptionformstringNo
ToneformstringNo
StatusformstringNo
PublishedVersionNoformint?No
PublishedAtformDateTime?No
PublishedByformstringNo
DraftDirtyformboolNo
DraftUpdatedAtformDateTime?No
DraftUpdatedByformstringNo
PackLabelformstringNo
SettingsJsonformstringNo
StatsformFormStatsNo
OfferedformList<string>No
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
FormStats Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
NeedDecisionformintNo
WaitingformintNo
OverdueformintNo

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.

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