EndPreviousNextEnd EndPrint This TopicEnd

GetFormFields

The GetFormFields webservice is used to get a list of fields to display in a form.

 

This is currently only usable for registration form fields, but in the future it will be used to get fields for enquiry forms or other kinds of module specific forms.

 

Data to be passed to the webservice

Variable name

Data type

Description

formName

String

The name of the form to get the fields for. For the registration form, use Registration

authToken

String

The authentication token for your session

 

Data which is returned

Variable name

Data type

Description

formFields

List of FormField types

A list of form fields, in the order that they should be displayed

errorCode

String

If your request was successful, the errorCode will be 0

If your request had a problem, there will be an error code for each kind of problem

errorMessage

String

A description of the problem with your error request (if there was a problem)

If your request was successful, this will be an empty string

 

The FormField data type

Varible name

Data type

Description

ElementID

String

The unique name for the form field

Definition

String

The type of field to be displayed (please see the child topic for more details on this)

IsRequired

Bool

Whether the field is mandatory or not

Label

String

The label for the field

Properties

List of FieldProperty types

A list of properties for the field, setting specific behaviours for the field

 

The FieldProperty data type

Varible name

Data type

Description

Key

String

The distinct name of the property (each FormField definition will have its own set of FieldProperty keys)

Value

String

The value of the property

 

Example XML for a GetFormFields request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

 <soap:Body>

         <GetFormFields xmlns="http://contegro.com/">

                 <authToken>14ffdfd6-78c3-4fc0-9c63-3902011640af</authToken>

                 <formName>Registration</formName>

         </GetFormFields>

 </soap:Body>

</soap:Envelope>

 

Example XML which is returned

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

 <soap:Body>

         <GetFormFieldsResponse xmlns="http://contegro.com/">

                 <GetFormFieldsResult>

                         <formFields>

                                 <FormField>

                                         <ElementID>EmailAddress</ElementID>

                                         <Definition>TextBox</Definition>

                                         <IsRequired>true</IsRequired>

                                         <Label>Email</Label>

                                         <Properties>

                                                 <FieldProperty>

                                                         <Key>MaxCharacters</Key>

                                                         <Value>100</Value>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>DefaultValue</Key>

                                                         <Value/>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>InFieldLabel</Key>

                                                         <Value>Email</Value>

                                                 </FieldProperty>

                                         </Properties>

                                 </FormField>

                                 <FormField>

                                         <ElementID>FirstName</ElementID>

                                         <Definition>TextBox</Definition>

                                         <IsRequired>true</IsRequired>

                                         <Label>First Name</Label>

                                         <Properties>

                                                 <FieldProperty>

                                                         <Key>MaxCharacters</Key>

                                                         <Value>50</Value>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>DefaultValue</Key>

                                                         <Value/>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>InFieldLabel</Key>

                                                         <Value>Your name</Value>

                                                 </FieldProperty>

                                         </Properties>

                                 </FormField>

                                 <FormField>

                                         <ElementID>LastName</ElementID>

                                         <Definition>TextBox</Definition>

                                         <IsRequired>true</IsRequired>

                                         <Label>Last Name</Label>

                                         <Properties>

                                                 <FieldProperty>

                                                         <Key>MaxCharacters</Key>

                                                         <Value>50</Value>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>DefaultValue</Key>

                                                         <Value/>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>InFieldLabel</Key>

                                                         <Value/>

                                                 </FieldProperty>

                                         </Properties>

                                 </FormField>

                                 <FormField>

                                         <ElementID>Password</ElementID>

                                         <Definition>TextBox</Definition>

                                         <IsRequired>true</IsRequired>

                                         <Label>Password</Label>

                                         <Properties>

                                                 <FieldProperty>

                                                         <Key>MaxCharacters</Key>

                                                         <Value>150</Value>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>DefaultValue</Key>

                                                         <Value/>

                                                 </FieldProperty>

                                                 <FieldProperty>

                                                         <Key>InFieldLabel</Key>

                                                         <Value/>

                                                 </FieldProperty>

                                         </Properties>

                                 </FormField>

                         </formFields>

                 </GetFormFieldsResult>

         </GetFormFieldsResponse>

 </soap:Body>

</soap:Envelope>

Topic Link