wsQuikForm Web Service

wsQuikForm

Click here for a complete list of operations.

GetFormDefinition

Get Form Definition

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/wsQuikHndForms/wsQuikForm.asmx HTTP/1.1
Host: tdcws01.tandridge.gov.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tandridge.gov.uk/QuikForms/GetFormDefinition"

<?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>
    <GetFormDefinition xmlns="http://tandridge.gov.uk/QuikForms/">
      <DefinitionID>string</DefinitionID>
    </GetFormDefinition>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetFormDefinitionResponse xmlns="http://tandridge.gov.uk/QuikForms/">
      <FormDefn>
        <FormDefnUID>int</FormDefnUID>
        <FormDefn FormDefnUID="int" Name="string" Description="string" LastModified="dateTime" LastModifiedBy="string" FirstCreated="dateTime" CreatedBy="string" Withdrawn="dateTime" EmailImageWidth="int" EmailHideFieldList="string" EmailHideFileList="string" AttachedDocImageWidth="int">
          <DefaultDocStorePath>string</DefaultDocStorePath>
          <DefaultFileUploadStorePath>string</DefaultFileUploadStorePath>
          <DefaultStyleLabelEmail>string</DefaultStyleLabelEmail>
          <DefaultStyleLabelForm>string</DefaultStyleLabelForm>
          <DefaultStyleDataEmail>string</DefaultStyleDataEmail>
          <DefaultStyleDataForm>string</DefaultStyleDataForm>
          <DefaultEmailLabelHTMLTagType>string</DefaultEmailLabelHTMLTagType>
          <DefaultEmailLabelHTMLTagAttrs>string</DefaultEmailLabelHTMLTagAttrs>
          <DefaultEmailDataHTMLTagType>string</DefaultEmailDataHTMLTagType>
          <DefaultEmailDataHTMLTagAttrs>string</DefaultEmailDataHTMLTagAttrs>
          <DefaultFormLabelHTMLTagType>string</DefaultFormLabelHTMLTagType>
          <DefaultFormLabelHTMLTagAttrs>string</DefaultFormLabelHTMLTagAttrs>
          <DefaultFormDataHTMLTagType>string</DefaultFormDataHTMLTagType>
          <DefaultFormDataHTMLTagAttrs>string</DefaultFormDataHTMLTagAttrs>
          <DefaultEmailPreRowHTML>string</DefaultEmailPreRowHTML>
          <DefaultEmailPostRowHTML>string</DefaultEmailPostRowHTML>
          <DefaultFormPreRowHTML>string</DefaultFormPreRowHTML>
          <DefaultFormPostRowHTML>string</DefaultFormPostRowHTML>
          <XSLTForEMail>string</XSLTForEMail>
          <EmailBeforeFieldsHTML>string</EmailBeforeFieldsHTML>
          <EmailAfterFieldsHTML>string</EmailAfterFieldsHTML>
          <EmailBeforeFileList>string</EmailBeforeFileList>
          <EmailAfterFileList>string</EmailAfterFileList>
          <EmailFileListEntry>string</EmailFileListEntry>
          <EmailFileListLinkEntry>string</EmailFileListLinkEntry>
          <EmailBeforeFileListEntry>string</EmailBeforeFileListEntry>
          <EmailBeforeFileListEntryLink>string</EmailBeforeFileListEntryLink>
          <EmailAfterFileListEntry>string</EmailAfterFileListEntry>
          <EmailAfterFileListEntryLink>string</EmailAfterFileListEntryLink>
          <AttachedDocHTMLTemplate>string</AttachedDocHTMLTemplate>
          <FormBeforeFieldsHTML>string</FormBeforeFieldsHTML>
          <FormAfterFieldsHTML>string</FormAfterFieldsHTML>
          <FormBeforeFileList>string</FormBeforeFileList>
          <FormAfterFileList>string</FormAfterFileList>
          <FormBeforeFileListEntry>string</FormBeforeFileListEntry>
          <FormAfterFileListEntry>string</FormAfterFileListEntry>
          <FormHideFieldList>string</FormHideFieldList>
          <FormFields>
            <FormField xsi:nil="true" />
            <FormField xsi:nil="true" />
          </FormFields>
          <FormActions>
            <FormAction xsi:nil="true" />
            <FormAction xsi:nil="true" />
          </FormActions>
        </FormDefn>
      </FormDefn>
    </GetFormDefinitionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/wsQuikHndForms/wsQuikForm.asmx HTTP/1.1
Host: tdcws01.tandridge.gov.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetFormDefinition xmlns="http://tandridge.gov.uk/QuikForms/">
      <DefinitionID>string</DefinitionID>
    </GetFormDefinition>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetFormDefinitionResponse xmlns="http://tandridge.gov.uk/QuikForms/">
      <FormDefn>
        <FormDefnUID>int</FormDefnUID>
        <FormDefn FormDefnUID="int" Name="string" Description="string" LastModified="dateTime" LastModifiedBy="string" FirstCreated="dateTime" CreatedBy="string" Withdrawn="dateTime" EmailImageWidth="int" EmailHideFieldList="string" EmailHideFileList="string" AttachedDocImageWidth="int">
          <DefaultDocStorePath>string</DefaultDocStorePath>
          <DefaultFileUploadStorePath>string</DefaultFileUploadStorePath>
          <DefaultStyleLabelEmail>string</DefaultStyleLabelEmail>
          <DefaultStyleLabelForm>string</DefaultStyleLabelForm>
          <DefaultStyleDataEmail>string</DefaultStyleDataEmail>
          <DefaultStyleDataForm>string</DefaultStyleDataForm>
          <DefaultEmailLabelHTMLTagType>string</DefaultEmailLabelHTMLTagType>
          <DefaultEmailLabelHTMLTagAttrs>string</DefaultEmailLabelHTMLTagAttrs>
          <DefaultEmailDataHTMLTagType>string</DefaultEmailDataHTMLTagType>
          <DefaultEmailDataHTMLTagAttrs>string</DefaultEmailDataHTMLTagAttrs>
          <DefaultFormLabelHTMLTagType>string</DefaultFormLabelHTMLTagType>
          <DefaultFormLabelHTMLTagAttrs>string</DefaultFormLabelHTMLTagAttrs>
          <DefaultFormDataHTMLTagType>string</DefaultFormDataHTMLTagType>
          <DefaultFormDataHTMLTagAttrs>string</DefaultFormDataHTMLTagAttrs>
          <DefaultEmailPreRowHTML>string</DefaultEmailPreRowHTML>
          <DefaultEmailPostRowHTML>string</DefaultEmailPostRowHTML>
          <DefaultFormPreRowHTML>string</DefaultFormPreRowHTML>
          <DefaultFormPostRowHTML>string</DefaultFormPostRowHTML>
          <XSLTForEMail>string</XSLTForEMail>
          <EmailBeforeFieldsHTML>string</EmailBeforeFieldsHTML>
          <EmailAfterFieldsHTML>string</EmailAfterFieldsHTML>
          <EmailBeforeFileList>string</EmailBeforeFileList>
          <EmailAfterFileList>string</EmailAfterFileList>
          <EmailFileListEntry>string</EmailFileListEntry>
          <EmailFileListLinkEntry>string</EmailFileListLinkEntry>
          <EmailBeforeFileListEntry>string</EmailBeforeFileListEntry>
          <EmailBeforeFileListEntryLink>string</EmailBeforeFileListEntryLink>
          <EmailAfterFileListEntry>string</EmailAfterFileListEntry>
          <EmailAfterFileListEntryLink>string</EmailAfterFileListEntryLink>
          <AttachedDocHTMLTemplate>string</AttachedDocHTMLTemplate>
          <FormBeforeFieldsHTML>string</FormBeforeFieldsHTML>
          <FormAfterFieldsHTML>string</FormAfterFieldsHTML>
          <FormBeforeFileList>string</FormBeforeFileList>
          <FormAfterFileList>string</FormAfterFileList>
          <FormBeforeFileListEntry>string</FormBeforeFileListEntry>
          <FormAfterFileListEntry>string</FormAfterFileListEntry>
          <FormHideFieldList>string</FormHideFieldList>
          <FormFields>
            <FormField xsi:nil="true" />
            <FormField xsi:nil="true" />
          </FormFields>
          <FormActions>
            <FormAction xsi:nil="true" />
            <FormAction xsi:nil="true" />
          </FormActions>
        </FormDefn>
      </FormDefn>
    </GetFormDefinitionResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/wsQuikHndForms/wsQuikForm.asmx/GetFormDefinition HTTP/1.1
Host: tdcws01.tandridge.gov.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

DefinitionID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<FormDefn xmlns="http://tandridge.gov.uk/QuikForms/">
  <FormDefnUID>int</FormDefnUID>
  <FormDefn FormDefnUID="int" Name="string" Description="string" LastModified="dateTime" LastModifiedBy="string" FirstCreated="dateTime" CreatedBy="string" Withdrawn="dateTime" EmailImageWidth="int" EmailHideFieldList="string" EmailHideFileList="string" AttachedDocImageWidth="int">
    <DefaultDocStorePath>string</DefaultDocStorePath>
    <DefaultFileUploadStorePath>string</DefaultFileUploadStorePath>
    <DefaultStyleLabelEmail>string</DefaultStyleLabelEmail>
    <DefaultStyleLabelForm>string</DefaultStyleLabelForm>
    <DefaultStyleDataEmail>string</DefaultStyleDataEmail>
    <DefaultStyleDataForm>string</DefaultStyleDataForm>
    <DefaultEmailLabelHTMLTagType>string</DefaultEmailLabelHTMLTagType>
    <DefaultEmailLabelHTMLTagAttrs>string</DefaultEmailLabelHTMLTagAttrs>
    <DefaultEmailDataHTMLTagType>string</DefaultEmailDataHTMLTagType>
    <DefaultEmailDataHTMLTagAttrs>string</DefaultEmailDataHTMLTagAttrs>
    <DefaultFormLabelHTMLTagType>string</DefaultFormLabelHTMLTagType>
    <DefaultFormLabelHTMLTagAttrs>string</DefaultFormLabelHTMLTagAttrs>
    <DefaultFormDataHTMLTagType>string</DefaultFormDataHTMLTagType>
    <DefaultFormDataHTMLTagAttrs>string</DefaultFormDataHTMLTagAttrs>
    <DefaultEmailPreRowHTML>string</DefaultEmailPreRowHTML>
    <DefaultEmailPostRowHTML>string</DefaultEmailPostRowHTML>
    <DefaultFormPreRowHTML>string</DefaultFormPreRowHTML>
    <DefaultFormPostRowHTML>string</DefaultFormPostRowHTML>
    <XSLTForEMail>string</XSLTForEMail>
    <EmailBeforeFieldsHTML>string</EmailBeforeFieldsHTML>
    <EmailAfterFieldsHTML>string</EmailAfterFieldsHTML>
    <EmailBeforeFileList>string</EmailBeforeFileList>
    <EmailAfterFileList>string</EmailAfterFileList>
    <EmailFileListEntry>string</EmailFileListEntry>
    <EmailFileListLinkEntry>string</EmailFileListLinkEntry>
    <EmailBeforeFileListEntry>string</EmailBeforeFileListEntry>
    <EmailBeforeFileListEntryLink>string</EmailBeforeFileListEntryLink>
    <EmailAfterFileListEntry>string</EmailAfterFileListEntry>
    <EmailAfterFileListEntryLink>string</EmailAfterFileListEntryLink>
    <AttachedDocHTMLTemplate>string</AttachedDocHTMLTemplate>
    <FormBeforeFieldsHTML>string</FormBeforeFieldsHTML>
    <FormAfterFieldsHTML>string</FormAfterFieldsHTML>
    <FormBeforeFileList>string</FormBeforeFileList>
    <FormAfterFileList>string</FormAfterFileList>
    <FormBeforeFileListEntry>string</FormBeforeFileListEntry>
    <FormAfterFileListEntry>string</FormAfterFileListEntry>
    <FormHideFieldList>string</FormHideFieldList>
    <FormFields>
      <FormField FieldOrder="int" Fieldmandatory="boolean" SingleValueOnly="boolean" HideIfNoData="boolean" ShowAsDataRow="boolean" HTMLFieldShowCondition="string" Removed="dateTime" FieldUID="int" FieldName="string">
        <FieldDisplayExpression>string</FieldDisplayExpression>
        <SubstituteEmailRow>string</SubstituteEmailRow>
        <SubstituteFormRow>string</SubstituteFormRow>
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </FormField>
      <FormField FieldOrder="int" Fieldmandatory="boolean" SingleValueOnly="boolean" HideIfNoData="boolean" ShowAsDataRow="boolean" HTMLFieldShowCondition="string" Removed="dateTime" FieldUID="int" FieldName="string">
        <FieldDisplayExpression>string</FieldDisplayExpression>
        <SubstituteEmailRow>string</SubstituteEmailRow>
        <SubstituteFormRow>string</SubstituteFormRow>
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </FormField>
    </FormFields>
    <FormActions>
      <FormAction Name="string" Code="string" Priority="int" Removed="dateTime">
        <ActionUID>int</ActionUID>
        <Description>string</Description>
        <ActionData1>string</ActionData1>
        <ActionData2>string</ActionData2>
        <ActionData3>string</ActionData3>
        <ActionData4>string</ActionData4>
        <ActionData5>string</ActionData5>
        <ActionData6>string</ActionData6>
        <ActionData7>string</ActionData7>
        <ActionData8>string</ActionData8>
        <ActionData9>string</ActionData9>
        <ActionData10>string</ActionData10>
        <ActionData11>string</ActionData11>
        <ActionData12>string</ActionData12>
      </FormAction>
      <FormAction Name="string" Code="string" Priority="int" Removed="dateTime">
        <ActionUID>int</ActionUID>
        <Description>string</Description>
        <ActionData1>string</ActionData1>
        <ActionData2>string</ActionData2>
        <ActionData3>string</ActionData3>
        <ActionData4>string</ActionData4>
        <ActionData5>string</ActionData5>
        <ActionData6>string</ActionData6>
        <ActionData7>string</ActionData7>
        <ActionData8>string</ActionData8>
        <ActionData9>string</ActionData9>
        <ActionData10>string</ActionData10>
        <ActionData11>string</ActionData11>
        <ActionData12>string</ActionData12>
      </FormAction>
    </FormActions>
  </FormDefn>
</FormDefn>

Parameter	Value
DefinitionID: