Appearition Platform JS

Namespace: Form

Appearition.Form

Use the functions under this module to access Form records on the Appearition platform

Namespaces

Manage

Methods

Appearition.Form.GetFormFieldListItemsSyncManifest (request, requestOptions)Appearition.Form.FormFieldListItemsSyncViewModel static

This will return the list of values for every list type field that appears in any form. It is a convenience method that can be invoked if needed. Note, the GetFormSyncManifest method will also return the list items for each field under each form so this is not a necessary method to invoke

Name Type Description
request Appearition.Form.FormFieldListItemsSyncViewModel

The unique identifier of the document
requestOptions Appearition.RequestOptions

Contains the various callback methods for this request
Returns:
Type Description
Appearition.Form.FormFieldListItemsSyncViewModel This is returned as part of the success callback function in the requestOptions param

Appearition.Form.GetFormSyncManifest (request, requestOptions)Appearition.Form.FormsSyncViewModel static

Retrieves a delta of new or modified Forms on the server. The delta is determined from the view model sent in the request body Will return the Appearition.Form.FormsSyncViewModel model

Name Type Description
request Appearition.Form.FormsSyncViewModel

Contains the identifiers for retrieving the required records
requestOptions Appearition.RequestOptions

Contains the various callback methods for this request
Returns:
Type Description
Appearition.Form.FormsSyncViewModel This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.Form.FieldSyncViewModel

Represents a specific field that appears on a form. A field is polymorphic in that it can be defined to represent a text field, a list field or anything else required.

Properties:
Name Type Description
FieldKey string

Unique identifies the Field
FieldType Appearition.Form.FieldTypeEnum

Identifies the face that this field must take (e.g. Text, List, Photo, etc). Note whilst this is a fixed enum, more types can be added in the future.
FieldLabel string

Text that is presented to the user as a prompt to the field
Instructions string

Text that is presented to the user as guidance when setting a value for the field
Ordinal number

The index position within the form that this specific field appears in. Zero based index.
IsComposite boolean

Deprecated. Note used
OrdinalComposite number

Deprecated. Note used
CompositeRecursion number

Deprecated. Note used
ListItems Array.<string>

A collection of values that the user can choose from. This is only applicable if the field type is a list

Appearition.Form.FieldTypeEnum

The various types that a field can look like

Properties:
Name Type Description
Radio number

401
Checkox number

402
TextboxSingleLine number

403
TextboxMultiLine number

404
SectionTitle number

405
TakePhoto number

406
ReadDocuments number

407
DateSelection number

408
ChooseFromList number

409
SubForm number

410
Barcode number

411
AttachFile number

412
AssetCheckIn number

413
AssetCheckOut number

414
TimeSelection number

415
DateTimeSelection number

416
VerifyAsset number

417
AssetCheckInOut number

418
AddPart number

419
ChooseParts number

420
NewAssetCheckIn number

421

Appearition.Form.FormFieldListItemsSyncViewModel

This data structure holds each option for each list that appear in each form. Each option has a unique key which is linked to a specific list field

Properties:
Name Type Description
ListItems Array.<Appearition.Form.ListItemSyncViewModel>

A collection of lists options

Appearition.Form.FormGroupSyncViewModel

This data structure holds the details of a specific Group which holds a collection of Forms

Properties:
Name Type Description
FormGroupId number

The unique identifier of the group
FormGroupName string

The name of the group
IsJobAllocated boolean

If set to true, a user will not be able to complete and submit any forms unless they have chosen an allocated job. If set to false, the user is able to complete and submit forms for any site and any job.
Ordinal number

The index position within all the groups that this specific group appears in. Zero based index.
Forms Array.<Appearition.Form.FormSyncViewModel>

The collection of Forms that have been associated to this group

Appearition.Form.FormsSyncViewModel

This data structure holds the details of all Groups which the Forms are then organised under. A group represents a process which may have one or many forms associated. Note the same form can appear under one or many groups.

Properties:
Name Type Description
FormGroups Array.<Appearition.Form.FormGroupSyncViewModel>

A collection of Groups of Forms

Appearition.Form.FormSyncViewModel

Represents a Form and all of the details

Properties:
Name Type Description
FormKey string

Unique identifies the Form
FormName string

The name of the Form
Instructions string

Text that is presented to the user as guidance when completing and submitting the form
Ordinal number

The index position within all the forms that this specific form appears in. Zero based index.
IsRequired boolean

Indicates if this form must be filled in and at least saved before proceeding to the next.
IsGateway boolean

Deprecated. Holds the same value as IsRequired
Fields Array.<Appearition.Form.FieldSyncViewModel>

A collection of fields that are presented in this form

Appearition.Form.ListItemSyncViewModel

Represents a specific option that appears in a list. The key determines into which actual field the option belongs to

Properties:
Name Type Description
FieldKey string

Unique identifies the Field to which this option is an item on.
ItemText string

The text that is displayed in the list for selection
Ordinal number

The index position within the list that this specific option appears in. Zero based index.