findUserProfile

Returns an authenticated user's profile. 20 July 2017 - V2 added to support many more fields. Please see WIKI page for more details on fields, descriptions, and lengths

Wiki Link: https://sites.google.com/a/interact.technology/wiki/r-d/sam/sam-apis

or Google Docs Link: https://docs.google.com/spreadsheets/d/1rFpXg1k10I8S7i6KYbiByLvrVXehXn9-AyWk9hAQZoE/edit#gid=0

Request

GET /rest/user/profile

Headers

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

Parameters

Parameter	Type	Required	Description
version		No	Added for V2 so that we can be backwardly compatible. Possible values are 2. If null or 1 will default to initial V1 behaviour.
includeUUID	boolean	No	true/false value indicating whether the user's internal UUID (email UUID) should be included in the response.

Response

200 OK

Returns a V1 UserProfile JSON:

{ "uAddress" : "1 Test St",
  "uCity" : null,
  "uCountryCode" : null,
  "uCountryName" : null,
  "uEmail" : "c@c.com.au",
  "uFax" : "0405 924 131",
  "uFirstName" : "IPAD",
  "uId" : 3,
  "uLastName" : "iPad User 1",
  "uMobile" : "0405 924 131",
  "uPhone" : "0405 924 131",
  "uPostcode" : null,
  "uStateCode" : null,
  "uStateName" : null,
  "uSuburb" : null,
  "uDepartment": null,
  "uDivision": null,
  "uTimezone": "Australia/Sydney"
}

{
  "uId": 8,
  "uTitleId": 1,
  "uTitle": "Associate Professor",
  "uGenderCode": "M",
  "uGenderName": "Male",
  "uEmail": "aaron.mcmullen@hypermedia.com.au",
  "uFirstName": "UPDATED FIRST NAME",
  "uLastName": "UPDATED LAST NAME",
  "uCountryCode": "AU",
  "uCountryName": "AUSTRALIA",
  "uPrimaryMobile": "123",
  "uDateOfBirth": "2018-04-30",
  "uInterests": "interests",
  "uDietaryRequirements": "dietary requirements",
  "uPhoto": null,
  "uEnableLocation": false,
  "uEnableNotifications": false,
  "uAllowAllEmails": true,
  "uAllowNewsletterEmail": true,
  "uProfessionId": 1,
  "uProfessionName": "Doctor",
  "uSpecialtyId": 1,
  "uSpecialtyName": "Addiction Medicine",
  "uOtherTitle": null,
  "uOtherProfession": null,
  "uOtherSpecialty": null,
  "uFacebookId": "facebook id",
  "uTwitterId": "twitter id",
  "uLinkedinId": "linkedin id",
  "uLinkedinUrl": "linkedin url",
  "uTimezoneId": null,
  "uConditionId": 1,
  "uTreatmentNotes": "See my local quack",
  "uInteractTsAndCs": "Y",
  "uInteractTsAndCsDate": null,
  "uSAMTrackingConsent": "Y",
  "uSAMTrackingConsentDate": null,
  "uiCloudConsent": "N",
  "uiCloudConsentDate": null,
  "uGoogleConsent": "N",
  "uGoogleConsentDate": null,
  "uFacebookConsent": "N",
  "uFacebookConsentDate": null,
  "addresses": [
    {
      "uuid": "1417762b-d628-4a7a-acf0-9cf9193db853",
      "type": "Personal",
      "typeCode": "P",
      "name": "Updated Name",
      "street": "updated street",
      "city": "updated city",
      "suburb": "updated suburb",
      "stateCode": "NZ-AUK",
      "state": "Auckland",
      "postcode": "updated postcode",
      "countryCode": "NZ",
      "country": "NEW ZEALAND",
      "email": "updated@email.com",
      "phone": "updated phone",
      "fax": "updated fax",
      "mobile": "updated mobile",
      "department": "updated department",
      "division": "updated division",
      "jobTitle": "updated job title"
    },
    {
      "uuid": "c438503e-d95c-4a9f-985b-e9ecfaf52cb1",
      "type": "Work",
      "typeCode": "W",
      "name": "Work Address 1 Name",
      "street": "Work Address 1 Street",
      "city": "Address 1 City",
      "suburb": "Address 1 Suburb",
      "stateCode": "AU-NSW",
      "state": "New South Wales",
      "postcode": "2000",
      "countryCode": "AU",
      "country": "AUSTRALIA",
      "email": "test@test.com",
      "phone": "phone",
      "fax": "fax",
      "mobile": "mobile",
      "department": "department",
      "division": "division",
      "jobTitle": "jobTitle"
    }
  ],
  "uCreationDate": "2018-04-25",
  "uIdentifiers": [
    {
      "uIdentifierId": 1234,
      "uIdentifierValue": "XYZ0123456789",
      "identifierName": "AHPRA",
      "identifierDesc": "Australian Health Practitioner Regulation Agency"
    }
  ],
  "xUserProfileFields": [
    {
      "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"
    },
    {
      "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"
    },
    {
      "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
    },
    {
      "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": "Dr Mickey Mouse"
    },
    {
      "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": "Take 1 pill three times a day after meals"
    },
    {
      "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": "Hospital ABC"
    },
    {
      "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"
    },
    {
      "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": "Nurse 1"
    }
  ]
}

Errors

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