profile /direct/profile/describe

Represents a user's profile. Because of the privacy settings that a user can set for individual parts of their profile, the information in the profile that is returned for a given user will be tailored based on the person requesting it.

/profile/:ID: (GET) Gets a user's profile. Response will be tailored to the person making the request according to the profile owners privacy settings (/profile/USER.xml). removeFriend /direct/profile/:ID:/removeFriend GET show image /direct/profile/:ID:/image GET show Retrieve the profile image for a user. Append /thumb to get the thumbnail (/profile/USER/image/thumb) if there is one. If there is no thumbnail, the main image will be returned. Append /avatar to get the avatar (/profile/USER/image/avatar) if there is one. If there is no avatar, the main image will be returned. Append /official to get the official image (/profile/USER/image/official) if there is one. If there is no official image, the default image will be returned. Optionally add the siteId URL param to allow site permissions to be checked (/profile/USER/image?siteId={siteid} or /profile/USER/image/thumb?siteId={siteid}) Returns binary of the image. Returns default image if no image exists or not allowed. Return 404 if user (or optional siteId) is invalid. Will always return an image if one exists, either by being uploaded or being a url (depending on how the system has been configured - see Profile2 sakai.properties). You can use it directly in an img tag <img src="/profile/USER/image[/thumb]" />, it should always return something. DO NOT specify any return format, ie .xml. friendStatus /direct/profile/:ID:/friendStatus GET show pronunciation /direct/profile/:ID:/pronunciation GET show confirmFriendRequest /direct/profile/:ID:/confirmFriendRequest GET show formatted /direct/profile/:ID:/formatted GET show unreadMessagesCount /direct/profile/:ID:/unreadMessagesCount GET show Return the number of unread messages for a user. Returns a failure (404) if you do not have access to view the count of the user's messages. incomingConnectionRequests /direct/profile/:ID:/incomingConnectionRequests GET show Return a list of connection requests to a user. Returns an empty list if none and a failure (404) if you do not have access to view the user's connection requests, or the user is invalid. requestFriend /direct/profile/:ID:/requestFriend GET show outgoingConnectionRequests /direct/profile/:ID:/outgoingConnectionRequests GET show ignoreFriendRequest /direct/profile/:ID:/ignoreFriendRequest GET show connections /direct/profile/:ID:/connections GET show Return a list of connections for a user. Returns an empty list if none and a failure (404) if you do not have access to view the user's connections, or the user is invalid. html xml json org.sakaiproject.profile2.model.UserProfile bean academicProfileUrl java.lang.String true true birthday java.lang.String true true birthdayDisplay java.lang.String true true businessBiography java.lang.String true true companyProfiles java.util.List true true course java.lang.String true true dateOfBirth java.util.Date true true department java.lang.String true true displayName java.lang.String true true email java.lang.String true true facsimile java.lang.String true true favouriteBooks java.lang.String true true favouriteMovies java.lang.String true true favouriteQuotes java.lang.String true true favouriteTvShows java.lang.String true true formattedBirthday java.lang.String true true homepage java.lang.String true true homephone java.lang.String true true imageThumbUrl java.lang.String true true imageUrl java.lang.String true true locked boolean true true mobilephone java.lang.String true true nickname java.lang.String true true personalSummary java.lang.String true true phoneticPronunciation java.lang.String true true position java.lang.String true true props java.util.Map true true publications java.lang.String true true room java.lang.String true true school java.lang.String true true socialInfo org.sakaiproject.profile2.model.SocialNetworkingInfo true true staffProfile java.lang.String true true status org.sakaiproject.profile2.model.ProfileStatus true true subjects java.lang.String true true universityProfileUrl java.lang.String true true userUuid java.lang.String true true workphone java.lang.String true true redirectUserAccount Allows for retrieval of a user's account details by redirecting to the user entity provider false 0 CoreEntityProvider org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider EntityProvider org.sakaiproject.entitybroker.entityprovider.EntityProvider ActionsExecutable org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable AutoRegisterEntityProvider org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider Describeable org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable Outputable org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable Redirectable org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable RequestAware org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware Resolvable org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable Sampleable org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable