WebSvcUserProfileService namespace

This documentation is preliminary and is subject to change.

The User Profile Service web service namespace is an arbitrary name for a reference to the UserProfileService.asmx web service in SharePoint Server 2013 Preview.

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.

For more information about the WSDL format, see the World Wide Web Consortium (W3C) WSDL Specification.

Classes

---

	Class	Description
	ContactData	Represents a user profile contact that contains information about the contact.
	GetUserProfileByIndexResult	Represents information about a user profile.
	InCommonData	Represents the colleagues, memberships, and manager data in common between two user profiles.
	Leader
	MemberGroupData	Represents information about a member group.
	MembershipData	Contains information about a membership.
	OrganizationProfileData	Represents an organization.
	PinnedLinkData	Represents information about a pinned link.
	PropertyData	Contains user profile property information.
	PropertyInfo	Represents the information about a user profile property.
	QuickLinkData	Represents the information about a quick link.
	SPTimeZone	Represents the time zone setting that is implemented on a SharePoint Server website.
	UserProfileService	Provides a Web service to manage user profiles.
	ValueData	Represents the value of a property for a user profile.

Enumerations

---

	Enumeration	Description
	ChoiceTypes	Defines the type of choice list for a user profile property.
	MembershipSource	Represents the source of a member group involved in a particular membership.
	Privacy	Represents the privacy level that specifies the set of users who are allowed to access a protected resource.
	SuggestionType	Specifies the type of suggestion.