GET api/Account/GetUserFields

Gets user fields.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

GetUserFieldsResult

Name	Description	Type	Additional information
Fields		Collection of UserFieldType	None.

Response Formats

application/json, text/json

Sample:

{
  "Fields": [
    {
      "Type": 1,
      "CustomFieldId": 1,
      "FilterSupported": true,
      "Index": 2,
      "Required": true,
      "PleaseSelect": true,
      "MinLength": 1,
      "MaxLength": 1,
      "IsUnique": true,
      "Title": "sample string 6",
      "CustomFieldType": 1,
      "Show": true,
      "ShowInRegistrationForm": true,
      "ShowInPublicRegistrationForm": true,
      "HintText": "sample string 10",
      "Items": [
        {
          "Title": "sample string 1",
          "Id": 2,
          "Index": 3
        },
        {
          "Title": "sample string 1",
          "Id": 2,
          "Index": 3
        }
      ]
    },
    {
      "Type": 1,
      "CustomFieldId": 1,
      "FilterSupported": true,
      "Index": 2,
      "Required": true,
      "PleaseSelect": true,
      "MinLength": 1,
      "MaxLength": 1,
      "IsUnique": true,
      "Title": "sample string 6",
      "CustomFieldType": 1,
      "Show": true,
      "ShowInRegistrationForm": true,
      "ShowInPublicRegistrationForm": true,
      "HintText": "sample string 10",
      "Items": [
        {
          "Title": "sample string 1",
          "Id": 2,
          "Index": 3
        },
        {
          "Title": "sample string 1",
          "Id": 2,
          "Index": 3
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<GetUserFieldsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Fields>
    <GetUserFieldsResult.UserFieldType>
      <CustomFieldId>1</CustomFieldId>
      <CustomFieldType>DropDown</CustomFieldType>
      <FilterSupported>true</FilterSupported>
      <HintText>sample string 10</HintText>
      <Index>2</Index>
      <IsUnique>true</IsUnique>
      <Items>
        <GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
          <Id>2</Id>
          <Index>3</Index>
          <Title>sample string 1</Title>
        </GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
        <GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
          <Id>2</Id>
          <Index>3</Index>
          <Title>sample string 1</Title>
        </GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
      </Items>
      <MaxLength>1</MaxLength>
      <MinLength>1</MinLength>
      <PleaseSelect>true</PleaseSelect>
      <Required>true</Required>
      <Show>true</Show>
      <ShowInPublicRegistrationForm>true</ShowInPublicRegistrationForm>
      <ShowInRegistrationForm>true</ShowInRegistrationForm>
      <Title>sample string 6</Title>
      <Type>FirstName</Type>
    </GetUserFieldsResult.UserFieldType>
    <GetUserFieldsResult.UserFieldType>
      <CustomFieldId>1</CustomFieldId>
      <CustomFieldType>DropDown</CustomFieldType>
      <FilterSupported>true</FilterSupported>
      <HintText>sample string 10</HintText>
      <Index>2</Index>
      <IsUnique>true</IsUnique>
      <Items>
        <GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
          <Id>2</Id>
          <Index>3</Index>
          <Title>sample string 1</Title>
        </GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
        <GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
          <Id>2</Id>
          <Index>3</Index>
          <Title>sample string 1</Title>
        </GetUserFieldsResult.UserFieldType.UserFieldDropDownItem>
      </Items>
      <MaxLength>1</MaxLength>
      <MinLength>1</MinLength>
      <PleaseSelect>true</PleaseSelect>
      <Required>true</Required>
      <Show>true</Show>
      <ShowInPublicRegistrationForm>true</ShowInPublicRegistrationForm>
      <ShowInRegistrationForm>true</ShowInRegistrationForm>
      <Title>sample string 6</Title>
      <Type>FirstName</Type>
    </GetUserFieldsResult.UserFieldType>
  </Fields>
</GetUserFieldsResult>