Appearance
updateXUserProfileField ​
Updates one or more eXtended User Profile fields for an authenticated user.
See General rules for usage from createXUserProfileField API.
Request ​
http
PUT rest/user/xprofile-fieldsHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
json
{
"xUserProfileFields": [
{
"userProfileFieldId": 33,
"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,
"profileGroupAlias": "My HUMIRA Treatment"
},
{
"userProfileFieldId": 34,
"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": 35,
"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": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"dateValue": 1720658108487
},
{
"userProfileFieldId": 36,
"profileField": {
"profileFieldId": 6,
"statusCode": "A",
"dataType": "String",
"profileFieldName": "Doctor Name",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": false
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
},
{
"userProfileFieldId": 37,
"profileField": {
"profileFieldId": 8,
"statusCode": "A",
"dataType": "String",
"profileFieldName": "Dosaging",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": false
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
},
{
"userProfileFieldId": 38,
"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": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
},
{
"userProfileFieldId": 39,
"profileField": {
"profileFieldId": 3,
"statusCode": "A",
"dataType": "ForeignKey",
"profileFieldName": "Medication",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": true
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"medicationId_1": 1,
"profileGroupAlias": "My HUMIRA Treatment"
},
{
"userProfileFieldId": 40,
"profileField": {
"profileFieldId": 7,
"statusCode": "A",
"dataType": "String",
"profileFieldName": "Nurse Name",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": false
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
}
]
}Response ​
200 OK ​
SUCCESS
json
{
"errorMessages": [],
"xUserProfileFields": [
{
"userProfileFieldId": 33,
"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,
"profileGroupAlias": "My HUMIRA Treatment"
},
{
"userProfileFieldId": 34,
"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": 35,
"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": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"dateValue": 1720658108487
},
{
"userProfileFieldId": 36,
"profileField": {
"profileFieldId": 6,
"statusCode": "A",
"dataType": "String",
"profileFieldName": "Doctor Name",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": false
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
},
{
"userProfileFieldId": 37,
"profileField": {
"profileFieldId": 8,
"statusCode": "A",
"dataType": "String",
"profileFieldName": "Dosaging",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": false
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
},
{
"userProfileFieldId": 38,
"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": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
},
{
"userProfileFieldId": 39,
"profileField": {
"profileFieldId": 3,
"statusCode": "A",
"dataType": "ForeignKey",
"profileFieldName": "Medication",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": true
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"medicationId_1": 1,
"profileGroupAlias": "My HUMIRA Treatment"
},
{
"userProfileFieldId": 40,
"profileField": {
"profileFieldId": 7,
"statusCode": "A",
"dataType": "String",
"profileFieldName": "Nurse Name",
"supportsMultiple": true,
"conditionField": false,
"conditionStageField": false,
"medicationField": false
},
"profileGroup": {
"profileGroupId": 1,
"profileGroupName": "Treatment",
"profileGroupFields": []
},
"profileGroupAlias": "My HUMIRA Treatment",
"stringValue": "UpdatedString"
}
]
}json
{
"errorMessages": [
{
"errorCode": 3000,
"errorMsg": "'userProfileFieldId' field cannot be null for updates!"
}
],
"xUserProfileFields": []
}Errors ​
| Exception | Description |
|---|---|
WSInvalidParameterException | See Error Definitions |
WSInvalidAuthTokenException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSUserServiceException | See Error Definitions |