Appearance
submitUserAssessment ​
Submits a user assessment for a user including all related field/question/score values.
Request ​
http
POST rest/user/user-assessmentsHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
SAMPLE REQUEST curl --location 'http://localhost:8080/nextinteract-webapp/rest/user/user-assessments'
--header 'x-nextinteract-authtoken: 7eJ4chBRRRGjRQ+SmQ7yMw=='
--header 'Content-Type: application/json'
--data '{ "userId": 9, "assessment": { "assessmentId": 0, "assessmentUuid": "79da1cd0-4ace-4ec8-b88d-de5acdc0f92a", "version": 1, "country": { "isoCode": "AU", "isoCountry": "AUSTRALIA" }, "assessmentName": "Test Assessment", "sourceOrganisation": "Unit Testing Only", "sourceAuthor": "Aaron M", "sourceUrl": "N/A", "assetNameOrUrl": "test_asset.html", "repeatUnit": 1, "repeatType": { "repeatTypeCode": "Y", "repeatTypeName": "Year" }, "assessmentFields": [
json
{
"assessmentFieldId": 3,
"assessmentFieldUuid": "74e934f8-9d12-4b2a-ba6c-b57fa20bc3c3",
"profileField": {
"profileFieldId": 12,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Waistline",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 3
},json
{
"assessmentFieldId": 4,
"assessmentFieldUuid": "3e911539-54b6-4f70-85ab-c38c1f15e584",
"profileField": {
"profileFieldId": 14,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "eGFR",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 4
},json
{
"assessmentFieldId": 1,
"assessmentFieldUuid": "6d782a55-1b57-4072-a7fe-9453ee70163d",
"profileField": {
"profileFieldId": 10,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Height",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 1
},json
{
"assessmentFieldId": 2,
"assessmentFieldUuid": "763eea8f-0bd8-4a67-990a-bc231d5a6333",
"profileField": {
"profileFieldId": 11,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Weight",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 2
},json
{
"assessmentFieldId": 5,
"assessmentFieldUuid": "b79a7101-d0e1-4246-8cf5-6801bc13af08",
"profileField": {
"profileFieldId": 19,
"statusCode": "A",
"dataType": "ForeignKey",
"profileFieldName": "Ethnicity",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": true
},
"profileFieldOrder": 5
},json
{
"assessmentFieldId": 6,
"assessmentFieldUuid": "438ac207-24bc-4f23-9a0d-cc582bfca0e1",
"profileField": {
"profileFieldId": 21,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Age",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 6
}json
{
"userProfileFieldId": 95,
"userProfileFieldUUID": "b37f8b5a-10a8-4238-a6e2-dc1b9f82f911",
"profileField": {
"profileFieldId": 10,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Height",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"integerValue": 188,
"assessmentFieldUUID": "6d782a55-1b57-4072-a7fe-9453ee70163d",
"userAssessmentUUID": "0fbc2b91-b082-4713-8ca3-5138eb83162f"
},json
{
"userProfileFieldId": 94,
"userProfileFieldUUID": "fcb10aeb-a98d-4e6d-a3f9-e292ff7e9faa",
"profileField": {
"profileFieldId": 19,
"statusCode": "A",
"dataType": "ForeignKey",
"profileFieldName": "Ethnicity",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": true
},
"assessmentFieldUUID": "b79a7101-d0e1-4246-8cf5-6801bc13af08",
"userAssessmentUUID": "0fbc2b91-b082-4713-8ca3-5138eb83162f"
},json
{
"userProfileFieldId": 93,
"userProfileFieldUUID": "494320de-b092-442e-9e0b-c073f486861b",
"profileField": {
"profileFieldId": 11,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Weight",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"integerValue": 80,
"assessmentFieldUUID": "763eea8f-0bd8-4a67-990a-bc231d5a6333",
"userAssessmentUUID": "0fbc2b91-b082-4713-8ca3-5138eb83162f"
},json
{
"userProfileFieldId": 96,
"userProfileFieldUUID": "9bd76fc1-152d-43f8-937a-6c6a1dca25b5",
"profileField": {
"profileFieldId": 12,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Waistline",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"integerValue": 43,
"assessmentFieldUUID": "74e934f8-9d12-4b2a-ba6c-b57fa20bc3c3",
"userAssessmentUUID": "0fbc2b91-b082-4713-8ca3-5138eb83162f"
}json
{
"dependentTypeJSON": {
"dependentTypeId": 2,
"dependentTypeName": "Daughter"
},
"name": "Ivy",
"dateOfBirth": 1417525200000,
"gender" : {
"genderCode":"F",
"genderName":"Female"
},
"colour":"#FFC0CB",
"condition1" :
{
"conditionId":28,
"conditionName":"Type 1 Diabetes"
},
"condition2" :
{
"conditionId":23,
"conditionName":"Eczema"
}
}Response ​
200 OK ​
json
{
"userAssessmentUuid": "0fbc2b91-b082-4713-8ca3-5138eb83162f",
"userId": 8,
"assessment": {
"assessmentId": 0,
"assessmentUuid": "79da1cd0-4ace-4ec8-b88d-de5acdc0f92a",
"version": 1,
"country": {
"isoCode": "AU",
"isoCountry": "AUSTRALIA"
},
"assessmentName": "Test Assessment",
"sourceOrganisation": "Unit Testing Only",
"sourceAuthor": "Aaron M",
"sourceUrl": "N/A",
"assetNameOrUrl": "test_asset.html",
"repeatUnit": 1,
"repeatType": {
"repeatTypeCode": "Y",
"repeatTypeName": "Year"
},
"assessmentFields": [
{
"assessmentFieldId": 1,
"assessmentFieldUuid": "6d782a55-1b57-4072-a7fe-9453ee70163d",
"profileField": {
"profileFieldId": 10,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Height",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 1
},
{
"assessmentFieldId": 3,
"assessmentFieldUuid": "74e934f8-9d12-4b2a-ba6c-b57fa20bc3c3",
"profileField": {
"profileFieldId": 12,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Waistline",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 3
},
{
"assessmentFieldId": 5,
"assessmentFieldUuid": "b79a7101-d0e1-4246-8cf5-6801bc13af08",
"profileField": {
"profileFieldId": 19,
"statusCode": "A",
"dataType": "ForeignKey",
"profileFieldName": "Ethnicity",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": true
},
"profileFieldOrder": 5
},
{
"assessmentFieldId": 2,
"assessmentFieldUuid": "763eea8f-0bd8-4a67-990a-bc231d5a6333",
"profileField": {
"profileFieldId": 11,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Weight",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 2
},
{
"assessmentFieldId": 6,
"assessmentFieldUuid": "438ac207-24bc-4f23-9a0d-cc582bfca0e1",
"profileField": {
"profileFieldId": 21,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "Age",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 6
},
{
"assessmentFieldId": 4,
"assessmentFieldUuid": "3e911539-54b6-4f70-85ab-c38c1f15e584",
"profileField": {
"profileFieldId": 14,
"statusCode": "A",
"dataType": "Integer",
"profileFieldName": "eGFR",
"profileFieldDesc": null,
"educationalResourceUrl": null,
"medicalPurposeUrl": null,
"supportsMultiple": true,
"unitOfMeasures": [],
"conditionField": false,
"conditionStageField": false,
"medicationField": false,
"postcodeField": false,
"ethnicityField": false
},
"profileFieldOrder": 4
}
]
},
"dateRecorded": 1743131299671,
"nextAssessmentDate": 1774667299671,
"created": 1743136763332,
"modified": 1743136763332,
"userProfileFields": []
}Errors ​
| Exception | Description |
|---|---|
WSInvalidParameterException | See Error Definitions |
WSInvalidAuthTokenException | See Error Definitions |
WSAlreadyExistsException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSUserServiceException | See Error Definitions |