Export (0) Print
Expand All

User Profile Web Service

SharePoint 2007

The User Profile Service Web service namespace is an arbitrary name for a reference to the UserProfileService.asmx Web service in Microsoft Office SharePoint Server 2007.

The UserProfileService class in the Web service includes methods to manage user profiles. For example, to add a link to the My Links page on the My Site for the specified account name, you use the AddLink method of the UserProfileService class. To remove a colleague from the My Colleagues page for the specified account name, you use the RemoveColleague method.

You can also use the relevant properties of various classes in the User Profile Service Web service namespace to get or set a particular property. For example, to get or set common memberships that two user profiles share, you use the Memberships property in the InCommonData class. To specify or determine whether a property value was changed for a particular user profile property, you use the IsValueChanged property of the PropertyData class.

The User Profile Service Web service provides a user profile interface for remote clients to read and create user profiles. To use the User Profile Service Web service library, you must generate a proxy class in either Microsoft Visual C# or Microsoft Visual Basic through which you can call the various Web service methods.

The Web Services Description Language (WSDL) for the User Profile Service Web service endpoint is accessed through UserProfileService.asmx?wsdl.

The following example shows the format of the URL to the User Profile Service Web service WSDL file.

http://< server >/< customsite >/_vti_bin/UserProfileService.asmx

If you do not have a custom site, you can use the following URL.

http://< server >/_vti_bin/UserProfileService.asmx

It is recommended that you create a custom site, and then use the URL that includes the custom site in the URL format.

The following table describes each element in the URL.

URL element

Description

server

The name of the server on which Microsoft Office SharePoint Server 2007 is deployed.

customsite

A custom Office SharePoint Server 2007 site that the server administrator creates.

<endpointname>.asmx

The name of the Web service endpoint. For the User Profile Service Web service, it is UserProfileService.asmx.

For more information about the WSDL format, see the World Wide Web Consortium (W3C) WSDL specification (http://www.w3.org/TR/wsdl).

 ClassDescription
Public class ContactData Represents a user profile contact, which contains information about the contact.
Public class GetUserProfileByIndexResult Returns a user profile and the location of the next user profile when the GetUserProfileByIndex(Int32) method of the UserProfileService Web service is called.
Public class InCommonData Represents the data that is common between two user profiles.
Public class MemberGroupData A structure that represents a member group.
Public class MembershipData Provides properties to retrieve and set information about a membership.
Public class PinnedLinkData Represents information about a pinned link.
Public class PropertyData Returns name/value pairs when the GetUserProfileByName method and the GetUserProfileByGuid method of the UserProfileService class are called.
Public class PropertyInfo Returns data from the user profile schema when the GetUserProfileSchema method of the UserProfileService is called.
Public class QuickLinkData Represents information about a quick link.
Public class UserProfileService Contains methods and properties used to call the UserProfileService Web service.
Public class ValueData Represents the value of a property for a user profile.

 EnumerationDescription
Public enumeration ChoiceTypes Defines whether a user profile property uses a choice list and, if it does use a choice list, describes the type of support.
Public enumeration MembershipGroupType Represents the types of the membership group.
Public enumeration MembershipSource Represents the source type of the membership.
Public enumeration Privacy Represents the privacy level, which you can set on user profile data.

Community Additions

ADD
Show:
© 2014 Microsoft