Skip to main content
Yosemite CrewDeveloper Docs

User Profile API

On this page

Manages a user's profile within a specific organisation (create, update, fetch, and profile-picture uploads). Called by the PIMS (Practice Information Management System, the clinic-facing web app). See the User API for the underlying user account.

Endpoints

POST /:organizationId/profile

  • Auth: requireWebAuth
  • Params: organizationId
  • Controller: UserProfileController.create
  • Response: 201: keys error, message, 500: keys message

PUT /:organizationId/profile

  • Auth: requireWebAuth
  • Params: organizationId
  • Controller: UserProfileController.update
  • Response: 404: keys message, 200: keys error, message, 500: keys message

GET /:organizationId/profile

  • Auth: requireWebAuth
  • Params: organizationId
  • Controller: UserProfileController.getByUserId
  • Response: 404: keys message, 200: keys error, message, 500: keys message

GET /:userId/:organizationId/profile

  • Auth: requireWebAuth
  • Params: userId, organizationId
  • Controller: UserProfileController.getUserProfileById
  • Response: 404: keys message, 200: keys error, message, 500: keys message

POST /:organizationId/profile-picture

  • Auth: requireWebAuth
  • Params: organizationId
  • Controller: UserProfileController.getProfilePictureUploadUrl
  • Response: 400: keys message, 200: keys s3Key, uploadUrl, 500: keys message