getUserDetailsByMembershipAPIKey

Retrieves a single User's profile including some connection-related info given a valid userId and API Key

Request

GET /rest/company/membership/profiles/single

Headers

Header	Required	Description
x-nextinteract-company-api-key	Yes	Admin-specific API key UUID provided to company

Parameters

Possible query parameters : Request must only pass "one" of the parameters below otherwise an error is thrown:

Parameter	Type	Required	Description
userId	Number	No	UserId of a connection's user profile to retrieve
email	String[255]	No	Email Address of a connection's user profile to retrieve
externalId	String[50]	No	ExternalId of a connection's Contact record relating to the profile to retrieve. More for enabling V1 VEEVA integration

Response

200 OK

{
  "user": {
    "fieldsToNull": [],
    "uTitleId": null,
    "uTitle": null,
    "uGenderCode": null,
    "uGenderName": null,
    "uEmail": "aaron.mcmullen@hypermedia.com.au",
    "uFirstName": "Joe",
    "uLastName": "Bloggs",
    "uCountryCode": null,
    "uCountryName": null,
    "uPrimaryMobile": null,
    "uDateOfBirth": null,
    "uInterests": null,
    "uDietaryRequirements": null,
    "uPhoto": null,
    "uEnableLocation": "N",
    "uEnableNotifications": "N",
    "uAllowAllEmails": "Y",
    "uAllowNewsletterEmail": "Y",
    "uProfessionId": null,
    "uProfessionName": null,
    "uSpecialtyId": null,
    "uSpecialtyName": null,
    "uOtherTitle": null,
    "uOtherProfession": null,
    "uOtherSpecialty": null,
    "uFacebookId": null,
    "uTwitterId": null,
    "uLinkedinId": null,
    "uLinkedinUrl": null,
    "uTimezoneId": null,
    "addresses": [
      {
        "uuid": "75594f4e-d053-4c93-b045-d013d4aea3c0",
        "type": "Work",
        "typeCode": "W",
        "name": "Address 1 Name",
        "street": "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"
      },
      {
        "uuid": "55794f4e-b052-2d93-a045-c014d4aea7b1",
        "type": "Work",
        "typeCode": "W",
        "name": "Alfred Hospital",
        "street": "Alfred Street",
        "city": "Melbourne",
        "suburb": "City",
        "stateCode": "AU-VIC",
        "state": "Victoria",
        "postcode": "3000",
        "countryCode": "AU",
        "country": "AUSTRALIA",
        "email": "test@test.com",
        "phone": "phone",
        "fax": "fax",
        "mobile": "mobile",
        "department": "department",
        "division": "division",
        "jobTitle": "jobTitle"
      }
    ],
    "uIdentifiers": [],
    "uId": 8
  },
  "connectionStatus": {
    "userId": 8,
    "externalId": null,
    "inviteStatusCode": "A",
    "inviteStatusName": "Accepted",
    "dInvited": 1533235880000,
    "dExpires": null,
    "dAccepted": null,
    "dRejected": null,
    "dCancelled": null
  }
}

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSRecordNotFoundException	See Error Definitions
WSCompanyApiKeyNotActiveException	See Error Definitions
WSCompanyNotActiveException	See Error Definitions
WSUserNotFoundException	See Error Definitions
WSUserNotActiveException	See Error Definitions
WSConnectionStatusNotActiveException	See Error Definitions
WSMembershipServiceException	See Error Definitions
WSIncorrectApiKeyTypeException	See Error Definitions