GET Form/get/{districtKey}/{formID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
districtKey

string

Required

formID

integer

Required

Body Parameters

None.

Response Information

Resource Description

FormInputComponents
NameDescriptionTypeAdditional information
FormID

integer

None.

ActiveFlag

boolean

None.

FormTitle

string

None.

HtmlHeaderDescription

string

None.

HtmlFooterDescription

string

None.

HtmlConfirm

string

None.

FormInputHtml

string

None.

AllowAttachmentCode

integer

None.

RegistrationID

integer

None.

OtherCongregationID

integer

None.

WebFormFields

Collection of FormInputField

None.

CongregationSelectItems

Collection of CongregationSelectItem

None.

CongregationStates

Collection of StateProvince

None.

Response Formats

application/json, text/json

Sample:
{
  "FormID": 1,
  "ActiveFlag": true,
  "FormTitle": "sample string 3",
  "HtmlHeaderDescription": "sample string 4",
  "HtmlFooterDescription": "sample string 5",
  "HtmlConfirm": "sample string 6",
  "FormInputHtml": "sample string 7",
  "AllowAttachmentCode": 8,
  "RegistrationID": 9,
  "OtherCongregationID": 10,
  "WebFormFields": [
    {
      "FormFieldType": 0,
      "Name": "sample string 1",
      "Label": "sample string 2",
      "Width": "sample string 3",
      "MaxLength": 4,
      "Required": true,
      "InputType": "sample string 6",
      "RegistrationValue": "sample string 7",
      "DefaultValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "FormFieldType": 0,
      "Name": "sample string 1",
      "Label": "sample string 2",
      "Width": "sample string 3",
      "MaxLength": 4,
      "Required": true,
      "InputType": "sample string 6",
      "RegistrationValue": "sample string 7",
      "DefaultValues": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "CongregationSelectItems": [
    {
      "ID": 1,
      "Name": "sample string 2"
    },
    {
      "ID": 1,
      "Name": "sample string 2"
    }
  ],
  "CongregationStates": [
    {
      "Abbr": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Abbr": "sample string 1",
      "Name": "sample string 2"
    }
  ]
}

text/html

Sample:
{"FormID":1,"ActiveFlag":true,"FormTitle":"sample string 3","HtmlHeaderDescription":"sample string 4","HtmlFooterDescription":"sample string 5","HtmlConfirm":"sample string 6","FormInputHtml":"sample string 7","AllowAttachmentCode":8,"RegistrationID":9,"OtherCongregationID":10,"WebFormFields":[{"FormFieldType":0,"Name":"sample string 1","Label":"sample string 2","Width":"sample string 3","MaxLength":4,"Required":true,"InputType":"sample string 6","RegistrationValue":"sample string 7","DefaultValues":["sample string 1","sample string 2"]},{"FormFieldType":0,"Name":"sample string 1","Label":"sample string 2","Width":"sample string 3","MaxLength":4,"Required":true,"InputType":"sample string 6","RegistrationValue":"sample string 7","DefaultValues":["sample string 1","sample string 2"]}],"CongregationSelectItems":[{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"}],"CongregationStates":[{"Abbr":"sample string 1","Name":"sample string 2"},{"Abbr":"sample string 1","Name":"sample string 2"}]}

application/xml, text/xml

Sample:
<FormInputComponents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DistrictAPI.Models">
  <ActiveFlag>true</ActiveFlag>
  <AllowAttachmentCode>8</AllowAttachmentCode>
  <CongregationSelectItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/UUALibrary.Models">
    <d2p1:CongregationSelectItem>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:CongregationSelectItem>
    <d2p1:CongregationSelectItem>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:CongregationSelectItem>
  </CongregationSelectItems>
  <CongregationStates xmlns:d2p1="http://schemas.datacontract.org/2004/07/UUALibrary.Models">
    <d2p1:StateProvince>
      <d2p1:Abbr>sample string 1</d2p1:Abbr>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:StateProvince>
    <d2p1:StateProvince>
      <d2p1:Abbr>sample string 1</d2p1:Abbr>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:StateProvince>
  </CongregationStates>
  <FormID>1</FormID>
  <FormInputHtml>sample string 7</FormInputHtml>
  <FormTitle>sample string 3</FormTitle>
  <HtmlConfirm>sample string 6</HtmlConfirm>
  <HtmlFooterDescription>sample string 5</HtmlFooterDescription>
  <HtmlHeaderDescription>sample string 4</HtmlHeaderDescription>
  <OtherCongregationID>10</OtherCongregationID>
  <RegistrationID>9</RegistrationID>
  <WebFormFields>
    <FormInputField>
      <DefaultValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </DefaultValues>
      <FormFieldType>Undefined</FormFieldType>
      <InputType>sample string 6</InputType>
      <Label>sample string 2</Label>
      <MaxLength>4</MaxLength>
      <Name>sample string 1</Name>
      <RegistrationValue>sample string 7</RegistrationValue>
      <Required>true</Required>
      <Width>sample string 3</Width>
    </FormInputField>
    <FormInputField>
      <DefaultValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </DefaultValues>
      <FormFieldType>Undefined</FormFieldType>
      <InputType>sample string 6</InputType>
      <Label>sample string 2</Label>
      <MaxLength>4</MaxLength>
      <Name>sample string 1</Name>
      <RegistrationValue>sample string 7</RegistrationValue>
      <Required>true</Required>
      <Width>sample string 3</Width>
    </FormInputField>
  </WebFormFields>
</FormInputComponents>