Get User Profile Field Group REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:49:47 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:49:47

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

Request Parameters

Name	Type	Location	Description	Required	Default	Options
Id	int	Query String	User profile field group id	Required
IncludeUserProfileFields	bool	Query String	Include profile fields	Optional

Example Requests

Widget Javascript

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

Example Responses

JSON

{
  "UserProfileFieldGroup": {
    "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"
          }
        ]
      }
    ]
  },
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <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>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>