Loading ...

REST API: Get Profile Fields | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get Profile Fields
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Profile Fields

0 
 /5
0 (0votes)

Get Profile Fields

GET /api/contenttype/fields/{EntityTypeID}

Gets a list of profile fields. Valid for Communifire version 6.0 and above.

Note This API does not return profile field data. To get profile field data for a user, use REST API: Get User's Profile Fields instead.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
EntityTypeID Used in the request URL as a path parameter

The entity type ID of user is 15.

Example Request

GET https://myintranet.communifire.com/api/contenttype/fields/15

Example Response

Profile field JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "FieldUseID": 24,
      "LabelResourceKey": "PeopleAboutText",
      "DescriptionResourceKey": "",
      "FieldType": 2,
      "FieldSubType": 13,
      "CSSClass": "",
      "FieldLabel": "About me",
      "RegexValidationExpression": "",
      "ParentFieldID": 0,
      "ContentTypeIDCSV": "",
      "SpaceIDCSV": "",
      "AuthorIDCSV": "",
      "TagIDCSV": "",
      "ContentTypeID": 15,
      "SystemName": "Bio",
      "NumRequired": 0,
      "NumPermitted": 1,
      "MinValue": "",
      "MaxValue": "",
      "ContentWidth": 0,
      "ContentHeight": 0,
      "ThumbnailWidth": 0,
      "ThumbnailHeight": 0,
      "RecreateThumbnail": false,
      "MaxFileSize": 0,
      "DefaultValue": "",
      "DefaultValue2": "",
      "Indexed": true,
      "IsUnique": false,
      "IsPreference": false,
      "IsLocked": true,
      "IsAdminOnly": false,
      "SavedFieldID": 0,
      "PicklistType": 0,
      "OptionAlphaSort": true,
      "UpdateSaved": false,
      "SourceFieldID": 0,
      "LinkedFieldID": 0,
      "ChildFieldWidgetsHTML": "",
      "SummaryTemplate": "",
      "PlaceholderID": 0,
      "DataID": 0,
      "ParentDataID": 0,
      "HasChanged": false,
      "OnPage": false,
      "ToBeDeleted": false,
      "IndexUpdateRequired": false,
      "TenantID": 0
    },
    {
      "FieldUseID": 42,
      "LabelResourceKey": "GlobalAddress1Text",
      "DescriptionResourceKey": "",
      "FieldType": 1,
      "FieldSubType": 1,
      "CSSClass": "",
      "FieldLabel": "Address 1",
      "RegexValidationExpression": "",
      "ParentFieldID": 41,
      "ContentTypeIDCSV": "",
      "SpaceIDCSV": "",
      "AuthorIDCSV": "",
      "TagIDCSV": "",
      "ContentTypeID": 15,
      "SystemName": "Address1",
      "NumRequired": 0,
      "NumPermitted": 1,
      "MinValue": "",
      "MaxValue": "",
      "ContentWidth": 0,
      "ContentHeight": 0,
      "ThumbnailWidth": 0,
      "ThumbnailHeight": 0,
      "RecreateThumbnail": false,
      "MaxFileSize": 0,
      "DefaultValue": "",
      "DefaultValue2": "",
      "Indexed": true,
      "IsUnique": false,
      "IsPreference": false,
      "IsLocked": true,
      "IsAdminOnly": false,
      "SavedFieldID": 35,
      "PicklistType": 0,
      "OptionAlphaSort": true,
      "UpdateSaved": false,
      "SourceFieldID": 0,
      "LinkedFieldID": 0,
      "ChildFieldWidgetsHTML": "",
      "SummaryTemplate": "",
      "PlaceholderID": 0,
      "DataID": 0,
      "ParentDataID": 0,
      "HasChanged": false,
      "OnPage": false,
      "ToBeDeleted": false,
      "IndexUpdateRequired": false,
      "TenantID": 0
    },
    {
      "FieldUseID": 43,
      "LabelResourceKey": "GlobalAddress2Text",
      "DescriptionResourceKey": "",
      "FieldType": 1,
      "FieldSubType": 1,
      "CSSClass": "",
      "FieldLabel": "Address 2",
      "RegexValidationExpression": "",
      "ParentFieldID": 41,
      "ContentTypeIDCSV": "",
      "SpaceIDCSV": "",
      "AuthorIDCSV": "",
      "TagIDCSV": "",
      "ContentTypeID": 15,
      "SystemName": "Address2",
      "NumRequired": 0,
      "NumPermitted": 1,
      "MinValue": "",
      "MaxValue": "",
      "ContentWidth": 0,
      "ContentHeight": 0,
      "ThumbnailWidth": 0,
      "ThumbnailHeight": 0,
      "RecreateThumbnail": false,
      "MaxFileSize": 0,
      "DefaultValue": "",
      "DefaultValue2": "",
      "Indexed": true,
      "IsUnique": false,
      "IsPreference": false,
      "IsLocked": true,
      "IsAdminOnly": false,
      "SavedFieldID": 36,
      "PicklistType": 0,
      "OptionAlphaSort": true,
      "UpdateSaved": false,
      "SourceFieldID": 0,
      "LinkedFieldID": 0,
      "ChildFieldWidgetsHTML": "",
      "SummaryTemplate": "",
      "PlaceholderID": 0,
      "DataID": 0,
      "ParentDataID": 0,
      "HasChanged": false,
      "OnPage": false,
      "ToBeDeleted": false,
      "IndexUpdateRequired": false,
      "TenantID": 0
    },
    {
      "FieldUseID": 63,
      "LabelResourceKey": "AuthenticatorKey",
      "DescriptionResourceKey": "",
      "FieldType": 1,
      "FieldSubType": 1,
      "CSSClass": "",
      "FieldLabel": "Authenticator Key",
      "RegexValidationExpression": "",
      "ParentFieldID": 0,
      "ContentTypeIDCSV": "",
      "SpaceIDCSV": "",
      "AuthorIDCSV": "",
      "TagIDCSV": "",
      "ContentTypeID": 15,
      "SystemName": "AuthenticatorKey",
      "NumRequired": 0,
      "NumPermitted": 1,
      "MinValue": "",
      "MaxValue": "",
      "ContentWidth": 0,
      "ContentHeight": 0,
      "ThumbnailWidth": 0,
      "ThumbnailHeight": 0,
      "RecreateThumbnail": false,
      "MaxFileSize": 0,
      "DefaultValue": "",
      "DefaultValue2": "",
      "Indexed": false,
      "IsUnique": false,
      "IsPreference": true,
      "IsLocked": true,
      "IsAdminOnly": false,
      "SavedFieldID": 0,
      "PicklistType": 0,
      "OptionAlphaSort": true,
      "UpdateSaved": false,
      "SourceFieldID": 0,
      "LinkedFieldID": 0,
      "ChildFieldWidgetsHTML": "",
      "SummaryTemplate": "",
      "PlaceholderID": 0,
      "DataID": 0,
      "ParentDataID": 0,
      "HasChanged": false,
      "OnPage": false,
      "ToBeDeleted": false,
      "IndexUpdateRequired": false,
      "TenantID": 0
    },
    {
      "FieldUseID": 46,
      "LabelResourceKey": "GlobalCityText",
      "DescriptionResourceKey": "",
      "FieldType": 1,
      "FieldSubType": 1,
      "CSSClass": "",
      "FieldLabel": "City",
      "RegexValidationExpression": "",
      "ParentFieldID": 41,
      "ContentTypeIDCSV": "",
      "SpaceIDCSV": "",
      "AuthorIDCSV": "",
      "TagIDCSV": "",
      "ContentTypeID": 15,
      "SystemName": "City",
      "NumRequired": 0,
      "NumPermitted": 1,
      "MinValue": "",
      "MaxValue": "",
      "ContentWidth": 0,
      "ContentHeight": 0,
      "ThumbnailWidth": 0,
      "ThumbnailHeight": 0,
      "RecreateThumbnail": false,
      "MaxFileSize": 0,
      "DefaultValue": "",
      "DefaultValue2": "",
      "Indexed": true,
      "IsUnique": false,
      "IsPreference": false,
      "IsLocked": true,
      "IsAdminOnly": false,
      "SavedFieldID": 39,
      "PicklistType": 0,
      "OptionAlphaSort": true,
      "UpdateSaved": false,
      "SourceFieldID": 0,
      "LinkedFieldID": 0,
      "ChildFieldWidgetsHTML": "",
      "SummaryTemplate": "",
      "PlaceholderID": 0,
      "DataID": 0,
      "ParentDataID": 0,
      "HasChanged": false,
      "OnPage": false,
      "ToBeDeleted": false,
      "IndexUpdateRequired": false,
      "TenantID": 0
    }
  ]
}

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software