Profile

The user profile details in HiveSocial are completely dynamic. You can manage profile sections and fields in these section.

Method: get

Authorization is required. Can be executed only by root group administrators. Have in mind that this method will return only the user profile settings, not the profile data of a specific user.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/profile

Parameters

Do not supply a request parameters with this method.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure (in which are also presented all the different fields and their objects:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Et irure enim aliquip sit ullamco.",
  "errors": [],
  "object": {
    "mandatoryFields": [
      {
        "id": "11197a91-b4eb-45b2-958a-07dae6213011",
        "name": "Email",
        "typeId": 1,
        "typeName": "TextBox",
        "position": 0,
        "sectionId": 0,
        "sectionName": "",
        "parentId": "",
        "parentName": "",
        "parentSelectedValueId": "",
        "parentSelectedValueName": "",
        "data": {}
      },
      {
        "id": "11197a91-b4eb-45b2-958a-07dae6213021",
        "name": "First name",
        "typeId": 1,
        "typeName": "TextBox",
        "position": 0,
        "sectionId": 0,
        "sectionName": "",
        "parentId": "",
        "parentName": "",
        "parentSelectedValueId": "",
        "parentSelectedValueName": "",
        "data": {}
      },
      {
        "id": "11197a91-b4eb-45b2-958a-07dae6213012",
        "name": "Last name",
        "typeId": 1,
        "typeName": "TextBox",
        "position": 0,
        "sectionId": 0,
        "sectionName": "",
        "parentId": "",
        "parentName": "",
        "parentSelectedValueId": "",
        "parentSelectedValueName": "",
        "data": {}
      },
      {
        "id": "11197a91-b4eb-45b2-958a-07dae6213043",
        "name": "Middle name",
        "typeId": 1,
        "typeName": "TextBox",
        "position": 0,
        "sectionId": 0,
        "sectionName": "",
        "parentId": "",
        "parentName": "",
        "parentSelectedValueId": "",
        "parentSelectedValueName": "",
        "data": {}
      }
    ],
    "aliasAux": {
      "sectionId": 1,
      "sectionName": "Work Focus",
      "fieldId": "86dbb520-159d-47cf-a5bc-c54ed236ad8b",
      "fieldName": "Firm"
    },
    "sections": [
      {
        "id": 1,
        "name": "Work Focus",
        "position": 1,
        "defaultVisibilityId": 2,
        "defaultVisibilityName": "Community",
        "fields": [
          {
            "id": "11197a91-b4eb-45b2-958a-07dae621304e",
            "name": "Company",
            "typeId": 1,
            "typeName": "TextBox",
            "position": 1,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": "",
              "description": "You job title at the organization or association you work for",
              "type": "SingleLine",
              "lines": "",
              "maxLength": "50",
              "required": false,
              "requiredMessage": "",
              "validateRegEx": "",
              "validateMessage": ""
            }
          },
          {
            "id": "028bd127-4677-4deb-8232-6202348fb522",
            "name": "I have IPhone",
            "typeId": 2,
            "typeName": "Checkbox",
            "position": 2,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": true,
              "description": "You job title at the organization or association you work for",
              "required": true,
              "requiredMessage": "This item is required"
            }
          },
          {
            "id": "028bd127-4677-4deb-8232-6202348fb521",
            "name": "Job Level",
            "typeId": 3,
            "typeName": "DropDownList",
            "position": 3,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "",
            "parentName": "",
            "parentSelectedValueId": "",
            "parentSelectedValueName": "",
            "data": {
              "taggable": true,
              "defaultValue": {
                "key": "938f0df5-e3ea-4ea2-b18e-93f643a6e27d",
                "value": "CEO/President",
                "position": 3
              },
              "description": "Your current job level",
              "required": true,
              "requiredMessage": "required",
              "options": [
                {
                  "key": "e6b57e21-d836-4669-8f4c-1392102716ba",
                  "value": "Please enter your current job level",
                  "position": 1
                },
                {
                  "key": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
                  "value": "Board Member",
                  "position": 2
                },
                {
                  "key": "938f0df5-e3ea-4ea2-b18e-93f643a6e27d",
                  "value": "CEO/President",
                  "position": 3
                },
                {
                  "key": "c7d58741-6f06-48da-85b8-b1975b354239",
                  "value": "Partner/Managing Director",
                  "position": 4
                }
              ]
            }
          },
          {
            "id": "971f7f45-d5f1-4430-add7-ef582eba6738",
            "name": "Industry",
            "typeId": 4,
            "typeName": "CheckBoxList",
            "position": 4,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "",
            "parentName": "",
            "parentSelectedValueId": "",
            "parentSelectedValueName": "",
            "data": {
              "taggable": true,
              "direction": "Horizontal",
              "columns": "2",
              "required": true,
              "requiredMessage": "required",
              "options": [
                {
                  "key": "f384cc59-06d9-4317-96cd-4e4c790184a4",
                  "value": "Advertising/Marketing",
                  "position": 1
                },
                {
                  "key": "970eaf79-d0b0-4bef-8361-d80993a9aa6e",
                  "value": "Computer/High Tech",
                  "position": 2
                },
                {
                  "key": "a89f55cd-5c29-4299-a927-222258e90f7f",
                  "value": "Retail",
                  "position": 3
                },
                {
                  "key": "b0bbcf6b-b223-467a-ac8f-8293cbfd41dd",
                  "value": "Other",
                  "position": 4
                }
              ]
            }
          },
          {
            "id": "11197a91-b4eb-45b2-958a-07dae6213041",
            "name": "Website",
            "typeId": 5,
            "typeName": "URLBox",
            "position": 5,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": "http://google.com",
              "description": "Your website URL",
              "type": "url",
              "maxLength": "50",
              "required": true,
              "requiredMessage": "required"
            }
          },
          {
            "id": "11197a91-b4eb-45b2-958a-07dae6213042",
            "name": "Description",
            "typeId": 6,
            "typeName": "DescriptionBox",
            "position": 6,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "description": "<strong>Default value</strong>"
            }
          },
          {
            "id": "949f6273-9971-4f63-bd82-5cfaeac7aeed",
            "name": "Geographic focus",
            "typeId": 7,
            "typeName": "RadioButtonList",
            "position": 7,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": {
                "key": "8f123733-47c4-42c0-bb89-0aba987e85db",
                "value": "Canada",
                "position": 3
              },
              "direction": "Vertical",
              "columns": "3",
              "required": true,
              "requiredMessage": "required",
              "options": [
                {
                  "key": "8327fb87-4559-498a-8940-77a925b51a35",
                  "value": "Africa",
                  "position": 1
                },
                {
                  "key": "2d5b9002-664c-41de-96a9-b9bc41b5a53d",
                  "value": "Australia",
                  "position": 2
                },
                {
                  "key": "8f123733-47c4-42c0-bb89-0aba987e85db",
                  "value": "Canada",
                  "position": 3
                },
                {
                  "key": "1cf54836-7114-4aa9-94bb-bcf02d19ecdd",
                  "value": "Other",
                  "position": 4
                }
              ]
            }
          },
          {
            "id": "e352d590-d3eb-490a-9461-d99c3a4f3397",
            "name": "Country",
            "typeId": 8,
            "typeName": "CountryDropDownList",
            "position": 8,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": {
                "key": "d57fba84-ae86-4275-a3aa-cf26b95924c5",
                "value": "Bulgaria",
                "position": 7
              },
              "description": "Your current country of living",
              "options": [
                {
                  "key": "508e19bd-1cbd-4364-9751-87ed00ec8f9b",
                  "value": "Argentina",
                  "position": 1
                },
                {
                  "key": "bf568498-b4ac-40bd-bb76-b4aa0082f176",
                  "value": "Australia",
                  "position": 2
                },
                {
                  "key": "8bf352f7-3c65-40fe-b763-9666ee2fab9a",
                  "value": "Austria",
                  "position": 3
                },
                {
                  "key": "baa934ff-51c0-480e-a913-b55160b9ddc1",
                  "value": "Bahamas",
                  "position": 4
                },
                {
                  "key": "511e6634-1414-4848-af07-75ba2f2db2f5",
                  "value": "Belgium",
                  "position": 5
                },
                {
                  "key": "7aa8c4be-558d-4e6f-a220-9a3a852561b2",
                  "value": "Brazil",
                  "position": 6
                },
                {
                  "key": "d57fba84-ae86-4275-a3aa-cf26b95924c5",
                  "value": "Bulgaria",
                  "position": 7
                },
                {
                  "key": "3b099c9d-646d-433d-9fa2-f9adcaa83edd",
                  "value": "Canada",
                  "position": 8
                },
                {
                  "key": "55b1d78b-14b7-41c5-9bba-70537b77e351",
                  "value": "China",
                  "position": 9
                },
                {
                  "key": "958dd280-718b-45a6-bc04-376497934d4c",
                  "value": "Denmark",
                  "position": 10
                },
                {
                  "key": "874d661a-f71b-437d-9980-bcdd65f0f880",
                  "value": "France",
                  "position": 11
                },
                {
                  "key": "a43c06fd-bd38-4bd6-8257-42fda17f8f12",
                  "value": "Germany",
                  "position": 12
                },
                {
                  "key": "8c99468b-24de-40f4-824c-7985c2df909f",
                  "value": "Greece",
                  "position": 13
                },
                {
                  "key": "dd476a96-0334-414d-b102-65d4afae22d8",
                  "value": "India",
                  "position": 14
                },
                {
                  "key": "36fe124d-a8f5-48cb-92f2-bfda83ebc72c",
                  "value": "Ireland",
                  "position": 15
                },
                {
                  "key": "4735375d-13de-4f61-8296-65fa0c19192b",
                  "value": "Israel",
                  "position": 16
                },
                {
                  "key": "a4c7dab0-7945-4f0f-bc81-963f24ede649",
                  "value": "Italy",
                  "position": 17
                },
                {
                  "key": "ae49a131-56b7-4856-90ca-79abf9450dc8",
                  "value": "Japan",
                  "position": 18
                },
                {
                  "key": "7394b36c-208a-42dc-9d43-3606b986548e",
                  "value": "Mexico",
                  "position": 19
                },
                {
                  "key": "66ab6bc3-2108-4a64-a3b2-5763bf02f26e",
                  "value": "Netherlands",
                  "position": 20
                },
                {
                  "key": "c2577dd6-e4a7-4390-8caa-af178757c314",
                  "value": "Russian Federation",
                  "position": 21
                },
                {
                  "key": "621940a7-506b-41ea-8de8-7f505d9ecfeb",
                  "value": "Spain",
                  "position": 22
                },
                {
                  "key": "a73cf8a7-3b62-4500-9df2-85c5af16ddbe",
                  "value": "Sweden",
                  "position": 23
                },
                {
                  "key": "fcabcca3-d33d-4352-9ec3-a2277ba2d8f3",
                  "value": "Switzerland",
                  "position": 24
                },
                {
                  "key": "85de7bb4-49d5-4493-a8af-dded038b6cf9",
                  "value": "Ukraine",
                  "position": 25
                },
                {
                  "key": "6d52cda9-55c1-4e1b-b6f8-f4a4ad57b92b",
                  "value": "United Kingdom",
                  "position": 26
                },
                {
                  "key": "ffd4f5e1-ca92-46aa-95e4-9479b29a0a15",
                  "value": "United States",
                  "position": 27
                },
                {
                  "key": "504b2e34-e0cd-4c32-b32a-f42943deb4d7",
                  "value": "Other",
                  "position": 28
                }
              ]
            }
          },
          {
            "id": "35c587db-ee95-453d-a0ca-1bd573a1e2ea",
            "name": "Bio",
            "typeId": 9,
            "typeName": "HTMLBox",
            "position": 9,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "defaultValue": "<strong>Default value</strong>",
              "description": "Your Bio",
              "required": true,
              "requiredMessage": "required"
            }
          },
          {
            "id": "35c587db-ee95-453d-a0ca-1bd573a1e1ea",
            "name": "Work History",
            "typeId": 10,
            "typeName": "WorkHistory",
            "position": 10,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true
            }
          },
          {
            "id": "e352d591-d3eb-490a-9461-d99c3a4f3397",
            "name": "Education",
            "typeId": 11,
            "typeName": "Education",
            "position": 11,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": {
                "key": "43931e74-0d81-479e-bf75-ee44851351cd",
                "value": "High School",
                "position": 4
              },
              "description": "Your current country of living",
              "options": [
                {
                  "key": "bf34e390-30b9-4bec-80b8-2334553defb7",
                  "value": "No Answer",
                  "position": 1
                },
                {
                  "key": "562242d1-fb11-475a-898b-00e183e275aa",
                  "value": "Elementary",
                  "position": 2
                },
                {
                  "key": "731e581e-cf57-4472-b645-a0c0e0b40abf",
                  "value": "Junior High",
                  "position": 3
                },
                {
                  "key": "43931e74-0d81-479e-bf75-ee44851351cd",
                  "value": "High School",
                  "position": 4
                },
                {
                  "key": "2ae41596-155f-448f-87f2-aededfd842fc",
                  "value": "Associates",
                  "position": 5
                },
                {
                  "key": "f1c91a43-0226-4618-b0d3-053bf39024f4",
                  "value": "Bachelor of Science",
                  "position": 6
                },
                {
                  "key": "94b24c52-dab3-49e5-b47d-e9f6af3016b8",
                  "value": "Bachelor of Arts",
                  "position": 7
                },
                {
                  "key": "b18b4b98-85af-4645-b960-6c798e33bbef",
                  "value": "Bachelor of Business Administration",
                  "position": 8
                },
                {
                  "key": "ab90e458-e31d-41f2-898e-ee1887c71e14",
                  "value": "Juris Doctorate",
                  "position": 9
                },
                {
                  "key": "d96ee3dd-be90-4434-9b67-3b5786f6808b",
                  "value": "Master of Science",
                  "position": 10
                },
                {
                  "key": "ae435c5a-9d85-4023-822d-5c1516565a73",
                  "value": "Master of Arts",
                  "position": 11
                },
                {
                  "key": "dd59472c-ed38-46ec-a65a-5c60ad508fba",
                  "value": "Master of Business Administration(MBA)",
                  "position": 12
                },
                {
                  "key": "79e8ae8f-3c57-43ce-9a45-fb90d492d122",
                  "value": "Master of Fine Arts(MFA)",
                  "position": 13
                },
                {
                  "key": "8de7e0f8-686f-42ac-862f-4dcddeba5c53",
                  "value": "PhD",
                  "position": 14
                }
              ]
            }
          },
          {
            "id": "2291c18f-5b7e-4148-8bd3-1505600dd902",
            "name": "Acronym of Organization",
            "typeId": 12,
            "typeName": "AutoCompleteTextBox",
            "position": 12,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "taggable": true,
              "defaultValue": {
                "key": "New York",
                "value": "New York",
                "position": 1
              },
              "description": "Acronym of your organization",
              "maxLength": "40",
              "required": true,
              "requiredMessage": "* required",
              "validateRegEx": "*",
              "validateMessage": "* not regexed",
              "allowFreeInput": true,
              "displayAsDropDown": true,
              "enableRemoteDataSource": true,
              "remoteDataSourceUrl": "http://google.com/api",
              "options": [
                {
                  "key": "New York",
                  "value": "New York",
                  "position": 1
                },
                {
                  "key": "Atlanta",
                  "value": "Atlanta",
                  "position": 2
                }
              ]
            }
          },
          {
            "id": "604f8b50-673c-429b-b055-489999e1fcc4",
            "name": "My bookmarks",
            "typeId": 13,
            "typeName": "URLList",
            "position": 13,
            "sectionId": 1,
            "sectionName": "Work Focus",
            "parentId": "028bd127-4677-4deb-8232-6202348fb521",
            "parentName": "Job title",
            "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
            "parentSelectedValueName": "Board member",
            "data": {
              "description": "List of my favorite websites",
              "maxLength": "50",
              "required": false,
              "requiredMessage": ""
            }
          }
        ],
        "accessWarnings": []
      },
      {
        "id": 2,
        "name": "Contact info",
        "position": 2,
        "defaultVisibilityId": 0,
        "defaultVisibilityName": "Nobody",
        "fields": [
          {
            "id": "86dbb520-159d-47cf-a5bc-c54ed2361d8b",
            "name": "Firm",
            "typeId": 1,
            "typeName": "TextBox",
            "position": 1,
            "sectionId": 2,
            "sectionName": "Work Focus",
            "taggable": false,
            "parentId": "fe6f2a25-eac5-4c18-81d5-60dfb3ffafe9",
            "parentName": "Industry",
            "parentSelectedValueId": "32f193d1-6b25-4af6-926d-c7789612bd24",
            "parentSelectedValueName": "Advertising/Marketing",
            "data": {
              "id": "textboxId",
              "type": "singleline",
              "lines": 1,
              "maxLength": "200",
              "required": true,
              "requiredMessage": "required",
              "defaultValue": "Default value",
              "description": "field description",
              "validateRegEx": "",
              "validateMessage": ""
            }
          }
        ],
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
mandatoryFields list (objects) these fields are always present in each of the users' profiles
aliasAux object Which of the fields to use in order to get the string, which is appended to the user names when presented the extended alias.
sections list (object) the section is a part of the profile that has a name and holds a certain amount of fields.

For more details about the section and fields objects, please look at the corresponding methods below.

Method: create profile section

Authorization is required. Can be executed only by root group administrators

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/profile/section

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
name string section name
position integer Section position
defaultVisibilityId integer The default visibility for this section (it can be personalized by the user afterwards). The alternatives are:
  • 0 - Nobody. By default only the user himself will be able to see this section details
  • 1 - My connections. By default only the user connections will be able to see this section details
  • 2 - Community. By default all registered users will be able to see this section details

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Section successfully created",
  "errors": [],
  "object": {
    "id": 12,
    "name": "Newly modified section",
    "position": 3,
    "defaultVisibilityId": 2,
    "defaultVisibilityName": "My Connections"
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differ from the posted one.

Method: update section

Authorization is required. Can be executed only by root group administrators.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/profile/section/{sectionId}

Parameters

propertyvaluedescription
sectionId integer In id of the updated record

Request body

propertyvaluedescription
name string section name
position integer Section position
defaultVisibilityId integer The default visibility for this section (it can be personalized by the user afterwards). The alternatives are:
  • 0 - Nobody. By default only the user himself will be able to see this section details
  • 1 - My connections. By default only the user connections will be able to see this section details
  • 2 - Community. By default all registered users will be able to see this section details

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Section successfully created",
  "errors": [],
  "object": {
    "id": 12,
    "name": "Newly modified section",
    "position": 3,
    "defaultVisibilityId": 2,
    "defaultVisibilityName": "My Connections"
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: delete profile section

Authorization is required. Can be executed only by root group administrators.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/profile/section/{sectionId}

Parameters

propertyvaluedescription
sectionId integer In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Section successfully created",
  "errors": [],
  "object": {
    "id": 12,
    "name": "Newly modified section",
    "position": 3,
    "defaultVisibilityId": 2,
    "defaultVisibilityName": "My Connections"
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted

Method: create profile field

Authorization is required. Can be executed only by root group administrators.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/profile/field

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
sectionId integer To which section you want this field inserted
name string How this field will be labeled
typeId integer The type of the field. The contents of the data property of the field should correspond to the selected type. The available options are:
  • 1 - Textbox
  • 2 - Checkbox
  • 3 - Dropdown ist
  • 4 - Checkbox list
  • 5 - URL box
  • 6 - Description box
  • 7 - Radio button list
  • 8 - Country dropdown list
  • 9 - HTML editor box
  • 10 - Work history
  • 11 - Education
  • 12 - Autocomplete textbox
  • 13 - URL list
position integer The field position in the list
parentId guid Creates a relation between the new field and the another field and its value. When the other fields value is selected this field is visible while the user is managing its profile. Only enumerable list field types can be selected as parent fields. (currently only the "dropdown list", "checkbox list" and the "radio button list" types)
parentSelectedValueId guid The value id of the selected parent
data object Other field type specific information. The POST object of field "data" property for each of the types you can review below.

1. Textbox (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
type string What type of textbox this is, according to the HTML 5 specification. The alternatives are:
  • SingleLine
  • MultiLine
  • Password
  • Color
  • Date
  • DateTime
  • DateTimeLocal
  • Email
  • Month
  • Number
  • Range
  • Search
  • Phone
  • Time
  • Url
  • Week
lines integer How many lines should be the textbox. Needed when the MultiLine type is set.
maxLength integer How many symbols are allowed to be input by the user in this field.
required boolean Is this input required?
requiredMessage string What message to show to the user, if the required validation triggers
defaultValue string If needed, what should be the default value for this field. Leave an empty string if you do not need a default value.
validateRegEx string The regex string of a custom validation if you need one. Leave an empty string, if this is not needed.
validateMessage string If the regex validation fails, what message should be presented to the user.

2. Checkbox (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
defaultValue boolean What should be the default value for this field.
required boolean The validation will fail, if the checkbox is not checked by the user
requiredMessage string What message to show to the user, if the required validation triggers

3. Dropdown list (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
defaultValue boolean What should be the default value for this field.
required boolean The validation will fail, if no value is provided
requiredMessage string What message to show to the user, if the required validation triggers
options list (object) List of the available options for this field. The option object properties are:
  • key - (guid) id of the selected option
  • value - (string) label of the selected option
  • position - (integer) position in the options list

4. Checkbox list (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
direction string The direction of the list. Alternatives are:
  • Horizontal
  • Vertical
columns integer With how many columns to present the list.
required boolean The validation will fail, if no value is provided
requiredMessage string What message to show to the user, if the required validation triggers
options list (object) List of the available options for this field. The option object properties are:
  • key - (guid) id of the selected option
  • value - (string) label of the selected option
  • position - (integer) position in the options list

5. URL box (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
type string What type of textbox this is, according to the HTML 5 specification. The alternatives are:
  • url
  • email
maxLength integer How many symbols are allowed to be input by the user in this textbox.
required boolean Is this input required?
requiredMessage string What message to show to the user, if the required validation triggers
defaultValue string If needed, what should be the default value for this field. Leave an empty string if you do not need a default value.

6. Description box (object > data)

descriptionstringUp to 255 chars. Will appear below the field

propertyvaluedescription

7. Radiobutton list (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
defaultValue boolean What should be the default value for this field.
direction string The direction of the list. Alternatives are:
  • Horizontal
  • Vertical
columns integer With how many columns to present the list.
required boolean The validation will fail, if no value is provided
requiredMessage string What message to show to the user, if the required validation triggers
options list (object) List of the available options for this field. The option object properties are:
  • key - (guid) id of the selected option
  • value - (string) label of the selected option
  • position - (integer) position in the options list

8. Country dropdown list (object > data)

This control has the same as the drop down list, with the only difference that on creation it has a countries list prefilled.

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
defaultValue boolean What should be the default value for this field.
required boolean The validation will fail, if no value is provided
requiredMessage string What message to show to the user, if the required validation triggers
options list (object) List of the available options for this field. The option object properties are:
  • key - (guid) id of the selected option
  • value - (string) label of the selected option
  • position - (integer) position in the options list

9. Htmlbox (object > data)

This control has the same as the drop down list, with the only difference that on creation it has a countries list prefilled.

propertyvaluedescription
description string Up to 255 chars. Will appear below the field
defaultValue boolean What should be the default value for this field.
required boolean The validation will fail, if no value is provided
requiredMessage string What message to show to the user, if the required validation triggers

10. Work history (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.

11. Education (object > data)

This control has the same as the drop down list, with the only difference that on creation it has a countries list prefilled.

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
defaultValue boolean What should be the default value for this field.
required boolean The validation will fail, if no value is provided
requiredMessage string What message to show to the user, if the required validation triggers
options list (object) List of the available options for this field. The option object properties are:
  • key - (guid) id of the selected option
  • value - (string) label of the selected option
  • position - (integer) position in the options list

12. Autocomplete (object > data)

propertyvaluedescription
taggable Boolean When presenting the value in the profile view page of the user, the system can convert it to a link. When someone clicks on that link, the system will present him all the users that have the same value in the same field of their profiles.
description string Up to 255 chars. Will appear below the field
maxLength integer How many symbols are allowed to be input by the user in this field.
required boolean Is this input required?
requiredMessage string What message to show to the user, if the required validation triggers
defaultValue string If needed, what should be the default value for this field. Leave an empty string if you do not need a default value.
validateRegEx string The regex string of a custom validation if you need one. Leave an empty string, if this is not needed.
validateMessage string If the regex validation fails, what message should be presented to the user.
allowFreeInput boolean The user can submit value that is not part of the options list
displayAsDropDown boolean The field can be presented as textbox with autocomplete or as a dropdown based on this setting
enableRemoteDataSource boolean The values for this field can be supplied by an external service, with an URL provided bellow.
remoteDataSourceUrl string If the regex validation fails, what message should be presented to the user. The external source needs to generate JSON with the following format:
{["value1", "value2", "value3"]}
options list (object) List of the available options for this field. The option object properties are:
  • key - (guid) id of the selected option
  • value - (string) label of the selected option
  • position - (integer) position in the options list

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Textbox successfully added to section!",
  "errors": [],
  "object": {
    "id": "028bd127-4677-4deb-8232-6202348fb522",
    "name": "Job Title 11",
    "typeId": 1,
    "typeName": "TextBox",
    "position": 3,
    "sectionId": 1,
    "sectionName": "Work Focus",
    "parentId": "028bd127-4677-4deb-8232-6202348fb521",
    "parentName": "Job title",
    "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
    "parentSelectedValueName": "Board member",
    "data": {
      "taggable": true,
      "defaultValue": "default 11",
      "description": "You job title at the organization or association you work for",
      "type": "MultiLine",
      "lines": "111",
      "maxLength": "501",
      "required": true,
      "requiredMessage": "required message",
      "validateRegEx": "*",
      "validateMessage": "not *"
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differ from the posted one.

Method: update profile field

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/profile/field/{fieldId}

Parameters

propertyvaluedescription
fieldId guid In id of the updated record

Request body

propertyvaluedescription
sectionId integer To which section you want this field inserted
name string How this field will be labeled
typeId integer The type of the field. As this is updating an already present field, this typeId should correspond to the type of the updated field.
position integer The field position in the list
parentId guid Creates a relation between the new field and the another field and its value. When the other fields value is selected this field is visible while the user is managing its profile. Only enumerable list field types can be selected as parent fields. (currently only the "dropdown list", "checkbox list" and the "radio button list" types)
parentSelectedValueId guid The value id of the selected parent
data object Other field type specific information. The POST object of field "data" property for each of the types you can review above in the Create method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Textbox successfully added to section!",
  "errors": [],
  "object": {
    "id": "028bd127-4677-4deb-8232-6202348fb522",
    "name": "Job Title 11",
    "typeId": 1,
    "typeName": "TextBox",
    "position": 3,
    "sectionId": 1,
    "sectionName": "Work Focus",
    "parentId": "028bd127-4677-4deb-8232-6202348fb521",
    "parentName": "Job title",
    "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
    "parentSelectedValueName": "Board member",
    "data": {
      "taggable": true,
      "defaultValue": "default 11",
      "description": "You job title at the organization or association you work for",
      "type": "MultiLine",
      "lines": "111",
      "maxLength": "501",
      "required": true,
      "requiredMessage": "required message",
      "validateRegEx": "*",
      "validateMessage": "not *"
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: delete

Authorization is required.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/profile/field/{fieldId}

Parameters

propertyvaluedescription
fieldId guid In id of the deleted record

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Textbox successfully added to section!",
  "errors": [],
  "object": {
    "id": "028bd127-4677-4deb-8232-6202348fb522",
    "name": "Job Title 11",
    "typeId": 1,
    "typeName": "TextBox",
    "position": 3,
    "sectionId": 1,
    "sectionName": "Work Focus",
    "parentId": "028bd127-4677-4deb-8232-6202348fb521",
    "parentName": "Job title",
    "parentSelectedValueId": "5157e632-d6a3-4c20-aaa5-a48a2c93ddbd",
    "parentSelectedValueName": "Board member",
    "data": {
      "taggable": true,
      "defaultValue": "default 11",
      "description": "You job title at the organization or association you work for",
      "type": "MultiLine",
      "lines": "111",
      "maxLength": "501",
      "required": true,
      "requiredMessage": "required message",
      "validateRegEx": "*",
      "validateMessage": "not *"
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted. The data property is filled according to the field type.