getXUserProfileFields

Retrieves all eXtended Profile fields for a given user. Each field has a type such as Long, String, ForeignKey, Date, Boolean etc. When creating fields, developers need to be careful to populate te correct field (of many). Possible input fields are: conditionId - use this field when dataType=ForeignKey and conditionField=trueconditionStageId - use this field when dataType=ForeignKey and conditionStageField=truemedicationId_1 - use this field when dataType=ForeignKey and medicationField=truemedicationId_2 - use this field when dataType=ForeignKey and medicationField=truemedicationId_3 - use this field when dataType=ForeignKey and medicationField=truemedicationId_4 - use this field when dataType=ForeignKey and medicationField=trueprofileGroupAlias - use this when inserting related fields into a group stringValue - use this field when dataType=StringintegerValue - use this field when dataType=IntegerdecimalValue - use this field when dataType=DecimaldateValue - use this field when dataType=DatebooleanValue - use this field when dataType=Boolean

Request

GET rest/user/xprofile-fields

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Response

200 OK

[
    {
        "userProfileFieldId": 25,
        "profileField": {
            "profileFieldId": 1,
            "statusCode": "A",
            "dataType": "ForeignKey",
            "profileFieldName": "Condition",
            "supportsMultiple": false,
            "conditionField": true,
            "conditionStageField": false,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": 86,
        "conditionStageId": null,
        "medicationId_1": null,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": null,
        "integerValue": null,
        "decimalValue": null,
        "dateValue": null,
        "booleanValue": null
    },
    {
        "userProfileFieldId": 26,
        "profileField": {
            "profileFieldId": 2,
            "statusCode": "A",
            "dataType": "ForeignKey",
            "profileFieldName": "Condition Stage",
            "supportsMultiple": false,
            "conditionField": false,
            "conditionStageField": true,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionStageId": 3,       
        "profileGroupAlias": "My HUMIRA Treatment"
    },
    {
        "userProfileFieldId": 27,
        "profileField": {
            "profileFieldId": 4,
            "statusCode": "A",
            "dataType": "DateTime",
            "profileFieldName": "Date of Diagnosis",
            "supportsMultiple": false,
            "conditionField": false,
            "conditionStageField": false,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": null,
        "conditionStageId": null,
        "medicationId_1": null,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": null,
        "integerValue": null,
        "decimalValue": null,
        "dateValue": 1720658108487,
        "booleanValue": null
    },
    {
        "userProfileFieldId": 28,
        "profileField": {
            "profileFieldId": 6,
            "statusCode": "A",
            "dataType": "String",
            "profileFieldName": "Doctor Name",
            "supportsMultiple": true,
            "conditionField": false,
            "conditionStageField": false,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": null,
        "conditionStageId": null,
        "medicationId_1": null,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": "TestString",
        "integerValue": null,
        "decimalValue": null,
        "dateValue": null,
        "booleanValue": null
    },
    {
        "userProfileFieldId": 29,
        "profileField": {
            "profileFieldId": 8,
            "statusCode": "A",
            "dataType": "String",
            "profileFieldName": "Dosaging",
            "supportsMultiple": true,
            "conditionField": false,
            "conditionStageField": false,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": null,
        "conditionStageId": null,
        "medicationId_1": null,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": "TestString",
        "integerValue": null,
        "decimalValue": null,
        "dateValue": null,
        "booleanValue": null
    },
    {
        "userProfileFieldId": 30,
        "profileField": {
            "profileFieldId": 5,
            "statusCode": "A",
            "dataType": "String",
            "profileFieldName": "Healthcare Provider/Practice Name",
            "supportsMultiple": true,
            "conditionField": false,
            "conditionStageField": false,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": null,
        "conditionStageId": null,
        "medicationId_1": null,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": "TestString",
        "integerValue": null,
        "decimalValue": null,
        "dateValue": null,
        "booleanValue": null
    },
    {
        "userProfileFieldId": 31,
        "profileField": {
            "profileFieldId": 3,
            "statusCode": "A",
            "dataType": "ForeignKey",
            "profileFieldName": "Medication",
            "supportsMultiple": true,
            "conditionField": false,
            "conditionStageField": false,
            "medicationField": true
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": null,
        "conditionStageId": null,
        "medicationId_1": 1,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": null,
        "integerValue": null,
        "decimalValue": null,
        "dateValue": null,
        "booleanValue": null
    },
    {
        "userProfileFieldId": 32,
        "profileField": {
            "profileFieldId": 7,
            "statusCode": "A",
            "dataType": "String",
            "profileFieldName": "Nurse Name",
            "supportsMultiple": true,
            "conditionField": false,
            "conditionStageField": false,
            "medicationField": false
        },
        "profileGroup": {
            "profileGroupId": 1,
            "profileGroupName": "Treatment",
            "profileGroupFields": []
        },
        "conditionId": null,
        "conditionStageId": null,
        "medicationId_1": null,
        "medicationId_2": null,
        "medicationId_3": null,
        "medicationId_4": null,
        "profileGroupAlias": "My HUMIRA Treatment",
        "stringValue": "TestString",
        "integerValue": null,
        "decimalValue": null,
        "dateValue": null,
        "booleanValue": null
    }
]

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSUserServiceException	See Error Definitions