List User Profile Field Group REST Endpoint

GET api.ashx/v2/userprofilefieldgroups.{json|xml}

Request Parameters

Name	Type	Location	Description	Required
IncludeUserProfileFields	bool	Query String	Include profile fields	Optional
PageIndex	int	Query String	Page of results to return	Optional
PageSize	int	Query String	Number of results to return	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/userprofilefieldgroups.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "UserProfileFieldGroups": [
    {
      "Title": "title",
      "Id": 6,
      "RawTitle": "rawtitle",
      "UserProfileFields": [
        {
          "Name": "name",
          "Title": "title",
          "RawTitle": "rawtitle",
          "IsSearchable": true,
          "FieldType": {
            "Id": 25,
            "Name": "name",
            "IsSearchable": true,
            "IsMultipleChoice": true
          },
          "FieldTypeChoices": [
            {
              "Label": "label",
              "Value": "value"
            },
            {
              "Label": "label",
              "Value": "value"
            }
          ]
        },
        {
          "Name": "name",
          "Title": "title",
          "RawTitle": "rawtitle",
          "IsSearchable": true,
          "FieldType": {
            "Id": 8,
            "Name": "name",
            "IsSearchable": true,
            "IsMultipleChoice": true
          },
          "FieldTypeChoices": [
            {
              "Label": "label",
              "Value": "value"
            },
            {
              "Label": "label",
              "Value": "value"
            }
          ]
        }
      ]
    },
    {
      "Title": "title",
      "Id": 4,
      "RawTitle": "rawtitle",
      "UserProfileFields": [
        {
          "Name": "name",
          "Title": "title",
          "RawTitle": "rawtitle",
          "IsSearchable": true,
          "FieldType": {
            "Id": 7,
            "Name": "name",
            "IsSearchable": true,
            "IsMultipleChoice": true
          },
          "FieldTypeChoices": [
            {
              "Label": "label",
              "Value": "value"
            },
            {
              "Label": "label",
              "Value": "value"
            }
          ]
        },
        {
          "Name": "name",
          "Title": "title",
          "RawTitle": "rawtitle",
          "IsSearchable": true,
          "FieldType": {
            "Id": 27,
            "Name": "name",
            "IsSearchable": true,
            "IsMultipleChoice": true
          },
          "FieldTypeChoices": [
            {
              "Label": "label",
              "Value": "value"
            },
            {
              "Label": "label",
              "Value": "value"
            }
          ]
        }
      ]
    }
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <UserProfileFieldGroups PageSize="2" PageIndex="0" TotalCount="2">
    <UserProfileFieldGroup>
      <Title>title</Title>
      <Id>6</Id>
      <RawTitle>rawtitle</RawTitle>
      <UserProfileFields>
        <RestUserProfileField>
          <Name>name</Name>
          <Title>title</Title>
          <RawTitle>rawtitle</RawTitle>
          <IsSearchable>true</IsSearchable>
          <FieldType>
            <Id>25</Id>
            <Name>name</Name>
            <IsSearchable>true</IsSearchable>
            <IsMultipleChoice>true</IsMultipleChoice>
          </FieldType>
          <FieldTypeChoices>
            <label>value</label>
            <label>value</label>
          </FieldTypeChoices>
        </RestUserProfileField>
        <RestUserProfileField>
          <Name>name</Name>
          <Title>title</Title>
          <RawTitle>rawtitle</RawTitle>
          <IsSearchable>true</IsSearchable>
          <FieldType>
            <Id>8</Id>
            <Name>name</Name>
            <IsSearchable>true</IsSearchable>
            <IsMultipleChoice>true</IsMultipleChoice>
          </FieldType>
          <FieldTypeChoices>
            <label>value</label>
            <label>value</label>
          </FieldTypeChoices>
        </RestUserProfileField>
      </UserProfileFields>
    </UserProfileFieldGroup>
    <UserProfileFieldGroup>
      <Title>title</Title>
      <Id>4</Id>
      <RawTitle>rawtitle</RawTitle>
      <UserProfileFields>
        <RestUserProfileField>
          <Name>name</Name>
          <Title>title</Title>
          <RawTitle>rawtitle</RawTitle>
          <IsSearchable>true</IsSearchable>
          <FieldType>
            <Id>7</Id>
            <Name>name</Name>
            <IsSearchable>true</IsSearchable>
            <IsMultipleChoice>true</IsMultipleChoice>
          </FieldType>
          <FieldTypeChoices>
            <label>value</label>
            <label>value</label>
          </FieldTypeChoices>
        </RestUserProfileField>
        <RestUserProfileField>
          <Name>name</Name>
          <Title>title</Title>
          <RawTitle>rawtitle</RawTitle>
          <IsSearchable>true</IsSearchable>
          <FieldType>
            <Id>27</Id>
            <Name>name</Name>
            <IsSearchable>true</IsSearchable>
            <IsMultipleChoice>true</IsMultipleChoice>
          </FieldType>
          <FieldTypeChoices>
            <label>value</label>
            <label>value</label>
          </FieldTypeChoices>
        </RestUserProfileField>
      </UserProfileFields>
    </UserProfileFieldGroup>
  </UserProfileFieldGroups>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

Recommended