SharePoint: Get User Profile Properties with REST API

In my last post SharePoint 2013: Working with User Profiles & JavaScript CSOM we saw how to get SharePoint UserProfile Properties using the JavaScript Client Object Model. In this post lets have a look at how to get them using the REST API. Here is a quick reference for the REST API endpoints.

(List of All User Properties and UserProfile Properties at the end of the post)

1) Get all properties of current user:

http://siteurl/_api/SP.UserProfiles.PeopleManager/GetMyProperties

2) Get single property of current user:

http://siteurl/_api/SP.UserProfiles.PeopleManager/GetMyProperties/PictureUrl
OR
http://siteurl/_api/SP.UserProfiles.PeopleManager/GetMyProperties?$select=PictureUrl

3) Get Multiple Properties for the current user:

http://siteurl/_api/SP.UserProfiles.PeopleManager/GetMyProperties?$select=PictureUrl,AccountName

4) Get all properties of Specific User:

For Office 365/SharePoint Online:
http://siteurl/_api/SP.UserProfiles.PeopleManager/GetPropertiesFor(accountName=@v)?@v='i:0%23.f|membership|vardhaman@siteurl.onmicrosoft.com'

For SharePoint 2013 On-Premises:
http://siteurl/_api/SP.UserProfiles.PeopleManager/GetPropertiesFor(accountName=@v)?@v='domain\username'

5) Get Specific UserProfile Property of Specific User:

For Office 365/SharePoint Online:
http://siteurl/_api/SP.UserProfiles.PeopleManager/GetUserProfilePropertyFor(accountName=@v,propertyName='LastName')?@v='i:0%23.f|membership|vardhaman@siteurl.onmicrosoft.com'


For SharePoint 2013 On-Premises:
http://siteurl/_api/SP.UserProfiles.PeopleManager/GetUserProfilePropertyFor(accountName=@v,propertyName='LastName')?@v='domain\username'

6) Get Multiple UserProfile Properties for Specific User:

Update (01/06/2016): Since the time I wrote this post, REST API batching has been implemented in SharePoint Online. As a result, we can make multiple REST requests to the GetUserProfilePropertiesFor function in a single REST call. This way, we can get Multiple custom/OOB UserProfile Properties for a Specific User without making multiple calls.

Here is my post on it:
SharePoint Online: Get UserProfile Properties with REST API Batching

Original Post Continues:

http://siteurl/_api/SP.UserProfiles.PeopleManager/GetUserProfilePropertiesFor

_api/SP.UserProfiles.PeopleManager/GetUserProfilePropertiesFor

As far as my research is concerned, this method is NOT supported in the REST API. The call to this method returns the following error:

"The method GetUserProfilePropertiesFor cannot be invoked as its parameter propertiesForUser is not supported."

If anybody finds any additional information on this, then I would love to update my blog on it. Here is my code for executing the above method:

	var theData = {
	"propertiesForUser": {
	"__metadata": { "type": "SP.UserProfiles.UserProfilePropertiesForUser" },
	"accountName": "i:0#.f|membership|vardhaman@tsunami684.onmicrosoft.com",
	"propertyNames": ["PreferredName", "Department"]
	}
	};
	var requestHeaders = {
	"Accept": "application/json;odata=verbose",
	"X-RequestDigest": jQuery("#__REQUESTDIGEST").val()
	};
	jQuery.ajax({
	url:_spPageContextInfo.webAbsoluteUrl + "/_api/SP.UserProfiles.PeopleManager/GetUserProfilePropertiesFor",
	type:"POST",
	data: JSON.stringify(theData),
	contentType : "application/json;odata=verbose",
	headers: requestHeaders,
	success:function(data){
	console.log(data);
	},
	error:function(jqxr,errorCode,errorThrown){
	console.log(jqxr.responseText);
	}
	});

view raw restup.js hosted with ❤ by GitHub

-------

List of User Properties (Use the GetPropertiesFor function for these):

AccountName
DirectReports
DisplayName
Email
ExtendedManagers
ExtendedReports
IsFollowed
LatestPost
Peers
PersonalUrl
PictureUrl"
Title
UserProfileProperties
UserUrl

List of User Profile Properties (Use the GetUserProfilePropertyFor function for these):

AboutMe

SPS-LastKeywordAdded

AccountName

SPS-Locale

ADGuid

SPS-Location

Assistant

SPS-MasterAccountName

CellPhone

SPS-MemberOf

Department

SPS-MUILanguages

EduExternalSyncState

SPS-MySiteUpgrade

EduOAuthTokenProviders

SPS-O15FirstRunExperience

EduPersonalSiteState

SPS-ObjectExists

EduUserRole

SPS-OWAUrl

Fax

SPS-PastProjects

FirstName

SPS-Peers

HomePhone

SPS-PersonalSiteCapabilities

LastName

SPS-PersonalSiteInstantiationState

Manager

SPS-PhoneticDisplayName

Office

SPS-PhoneticFirstName

PersonalSpace

SPS-PhoneticLastName

PictureURL

SPS-PrivacyActivity

PreferredName

SPS-PrivacyPeople

PublicSiteRedirect

SPS-ProxyAddresses

QuickLinks

SPS-RegionalSettings-FollowWeb

SID

SPS-RegionalSettings-Initialized

SISUserId

SPS-ResourceAccountName

SPS-AdjustHijriDays

SPS-ResourceSID

SPS-AltCalendarType

SPS-Responsibility

SPS-Birthday

SPS-SavedAccountName

SPS-CalendarType

SPS-SavedSID

SPS-ClaimID

SPS-School

SPS-ClaimProviderID

SPS-ShowWeeks

SPS-ClaimProviderType

SPS-SipAddress

SPS-ContentLanguages

SPS-Skills

SPS-DataSource

SPS-SourceObjectDN

SPS-Department

SPS-StatusNotes

SPS-DisplayOrder

SPS-Time24

SPS-DistinguishedName

SPS-TimeZone

SPS-DontSuggestList

SPS-UserPrincipalName

SPS-Dotted-line

SPS-WorkDayEndHour

SPS-EmailOptin

SPS-WorkDayStartHour

SPS-FeedIdentifier

SPS-WorkDays

SPS-FirstDayOfWeek

Title

SPS-FirstWeekOfYear

UserName

SPS-HashTags

UserProfile_GUID

SPS-HireDate

WebSite

SPS-Interests

WorkEmail

SPS-JobTitle

WorkPhone

SPS-LastColleagueAdded

Include Caching in jQuery getScript

While going through some MSDN documentation on SharePoint 2013, I noticed that Microsoft has suggested to use the jQuery.getScript method to load the SP.Runtime.js and the SP.js files on the page.
For Example:

	jQuery.getScript(_spPageContextInfo.webAbsoluteUrl+"/_layouts/15/sp.runtime.js",function(){
	console.log("sp.runtime.js loaded");
	jQuery.getScript(_spPageContextInfo.webAbsoluteUrl+"/_layouts/15/sp.js",function(){
	console.log("sp.js loaded");
	});
	});

view raw getScript.js hosted with ❤ by GitHub

I did not think about this twice but when I actually brought this into practice, I noticed that the function was fetching the files every time the page would load. After a bit of digging in the jQuery documentation, I found out that this is because the jQuery.getScript function disables caching. It gets the fresh copy of requested files every time by appending a current time time stamp at the end of the file path. You can see the firebug screen-cap of the call here:

This is not good for us because I don't want to spend extra time getting a fresh copy of the file on every page load. We know that once the file is fetched, the browser caches it and maintains a copy if any further requests for the same file are made in the future. jQuery.getScript by default does not allow us to take the advantage of this feature.

To overcome this limitation. I dug a little deeper into the jQuery docs and found that jQuery.getScript internally calls the good old jQuery.ajax function. This function has a "cache" parameter which we can use to set whether the ajax function looks into the browser cache for the requested file or it directly fetches it from the location. I created a handy function to wrap around the jQuery.ajax call to support caching. Here is the code:

	jQuery.getCachedScript = function(url,callback){
	jQuery.ajax({
	dataType: "script",
	cache: true,
	url: url,
	success:callback
	});
	};
	jQuery.getCachedScript(_spPageContextInfo.webAbsoluteUrl+"/_layouts/15/sp.runtime.js",function(){
	console.log("sp.runtime.js loaded");
	jQuery.getCachedScript(_spPageContextInfo.webAbsoluteUrl+"/_layouts/15/sp.js",function(){
	console.log("sp.js loaded");
	});
	});

view raw getCachedScript.js hosted with ❤ by GitHub

After I run this code, I get the following output in firebug. As you can see, there is no time-stamp at the end of the second request and also the time taken to fetch the file is significantly less (about 90% less) than the call to get the fresh copy.

So as you saw, we have built our own wrapper around the jQuery.ajax function which allows us to get cached files and significantly improve page load times. Hope you find this tip helpful!

Happy JavaScripting!

Batch Operations using the JavaScript Client Object Model

To improve performance and to reduce the time taken for data to travel over the wire, we can do batch operations using the Client Object Model in SharePoint. This can really help in reducing load time of pages and make the user experience better. Batch operations can be done using the .NET as well as the JavaScript Client Object Model. In this post, we are going to focus on how to perform batch operations using the JavaScript Client Object Model. In each of the following operations, only one call from the client to server will be made. It will contain all the information needed to perform the necessary operation. So without further ado, here is the code:

1) Batch Add Items to List:

	function createListItems() {
	var itemArray = [];
	var clientContext = SP.ClientContext.get_current();
	var oList = clientContext.get_web().get_lists().getByTitle('TestList');
	for(var i = 0; i< 5; i++){
	var itemCreateInfo = new SP.ListItemCreationInformation();
	var oListItem = oList.addItem(itemCreateInfo);
	oListItem.set_item('Title', 'My New Item!' + i);
	oListItem.update();
	itemArray[i] = oListItem;
	clientContext.load(itemArray[i]);
	}
	clientContext.executeQueryAsync(onQuerySucceeded, onQueryFailed);
	}
	function onQuerySucceeded() {
	alert('Items created');
	}
	function onQueryFailed(sender, args) {
	alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
	}
	createListItems();

view raw batchadd.js hosted with ❤ by GitHub

2) Batch Update Items from List:

	function updateListItems() {
	var itemArray = [];
	var clientContext = SP.ClientContext.get_current();
	var oList = clientContext.get_web().get_lists().getByTitle('TestList');
	for(var i = 1; i<= 5; i++){
	var oListItem = oList.getItemById(i);
	oListItem.set_item('Title', 'My Updated Item!' + i);
	oListItem.update();
	itemArray[i] = oListItem;
	clientContext.load(itemArray[i]);
	}
	clientContext.executeQueryAsync(onQuerySucceeded, onQueryFailed);
	}
	function onQuerySucceeded() {
	alert('Items Updated');
	}
	function onQueryFailed(sender, args) {
	alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
	}
	updateListItems();

view raw batchupdate.js hosted with ❤ by GitHub

3) Batch Delete Items from List:

	function deleteListItems() {
	var clientContext = SP.ClientContext.get_current();
	var oList = clientContext.get_web().get_lists().getByTitle('TestList');
	for(var i = 0; i<= 5; i++){
	var oListItem = oList.getItemById(i);
	oListItem.deleteObject();
	}
	clientContext.executeQueryAsync(onQuerySucceeded, onQueryFailed);
	}
	function onQuerySucceeded() {
	alert('Items Deleted');
	}
	function onQueryFailed(sender, args) {
	alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
	}
	deleteListItems();

view raw batchdelete.js hosted with ❤ by GitHub

Now let us analyze what happens behind the scenes when we make one of these batch operations. Here is the firebug screen grab of the call to batch create 5 items:

Now as you can see, only one call is made from the client to the server. It contains all the XML necessary for creating the 5 items. Here is the relevant XML:

	<Request xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="Javascript Library">
	<Actions>
	<ObjectPath Id="41" ObjectPathId="40"></ObjectPath>
	<Method Name="SetFieldValue" Id="42" ObjectPathId="40">
	<Parameters>
	<Parameter Type="String">Title</Parameter>
	<Parameter Type="String">My New Item!0</Parameter>
	</Parameters>
	</Method>
	<Method Name="Update" Id="43" ObjectPathId="40"></Method>
	<Query Id="44" ObjectPathId="40">
	<Query SelectAllProperties="true">
	<Properties>
	<Property Name="FileSystemObjectType" ScalarProperty="true"></Property>
	<Property Name="Id" ScalarProperty="true"></Property>
	<Property Name="Title" ScalarProperty="true"></Property>
	</Properties>
	</Query>
	</Query>
	<ObjectPath Id="46" ObjectPathId="45"></ObjectPath>
	<Method Name="SetFieldValue" Id="47" ObjectPathId="45">
	<Parameters>
	<Parameter Type="String">Title</Parameter>
	<Parameter Type="String">My New Item!1</Parameter>
	</Parameters>
	</Method>
	<Method Name="Update" Id="48" ObjectPathId="45"></Method>
	<Query Id="49" ObjectPathId="45">
	<Query SelectAllProperties="true">
	<Properties>
	<Property Name="FileSystemObjectType" ScalarProperty="true"></Property>
	<Property Name="Id" ScalarProperty="true"></Property>
	<Property Name="Title" ScalarProperty="true"></Property>
	</Properties>
	</Query>
	</Query>
	<ObjectPath Id="51" ObjectPathId="50"></ObjectPath>
	<Method Name="SetFieldValue" Id="52" ObjectPathId="50">
	<Parameters>
	<Parameter Type="String">Title</Parameter>
	<Parameter Type="String">My New Item!2</Parameter>
	</Parameters>
	</Method>
	<Method Name="Update" Id="53" ObjectPathId="50"></Method>
	<Query Id="54" ObjectPathId="50">
	<Query SelectAllProperties="true">
	<Properties>
	<Property Name="FileSystemObjectType" ScalarProperty="true"></Property>
	<Property Name="Id" ScalarProperty="true"></Property>
	<Property Name="Title" ScalarProperty="true"></Property>
	</Properties>
	</Query>
	</Query>
	<ObjectPath Id="56" ObjectPathId="55"></ObjectPath>
	<Method Name="SetFieldValue" Id="57" ObjectPathId="55">
	<Parameters>
	<Parameter Type="String">Title</Parameter>
	<Parameter Type="String">My New Item!3</Parameter>
	</Parameters>
	</Method>
	<Method Name="Update" Id="58" ObjectPathId="55"></Method>
	<Query Id="59" ObjectPathId="55">
	<Query SelectAllProperties="true">
	<Properties>
	<Property Name="FileSystemObjectType" ScalarProperty="true"></Property>
	<Property Name="Id" ScalarProperty="true"></Property>
	<Property Name="Title" ScalarProperty="true"></Property>
	</Properties>
	</Query>
	</Query>
	<ObjectPath Id="61" ObjectPathId="60"></ObjectPath>
	<Method Name="SetFieldValue" Id="62" ObjectPathId="60">
	<Parameters>
	<Parameter Type="String">Title</Parameter>
	<Parameter Type="String">My New Item!4</Parameter>
	</Parameters>
	</Method>
	<Method Name="Update" Id="63" ObjectPathId="60"></Method>
	<Query Id="64" ObjectPathId="60">
	<Query SelectAllProperties="true">
	<Properties>
	<Property Name="FileSystemObjectType" ScalarProperty="true"></Property>
	<Property Name="Id" ScalarProperty="true"></Property>
	<Property Name="Title" ScalarProperty="true"></Property>
	</Properties>
	</Query>
	</Query>
	</Actions>
	<ObjectPaths>
	<Method Id="40" ParentId="6" Name="AddItem">
	<Parameters>
	<Parameter TypeId="{54cdbee5-0897-44ac-829f-411557fa11be}">
	<Property Name="FolderUrl" Type="Null"></Property>
	<Property Name="LeafName" Type="Null"></Property>
	<Property Name="UnderlyingObjectType" Type="Number">0</Property>
	</Parameter>
	</Parameters>
	</Method>
	<Method Id="45" ParentId="6" Name="AddItem">
	<Parameters>
	<Parameter TypeId="{54cdbee5-0897-44ac-829f-411557fa11be}">
	<Property Name="FolderUrl" Type="Null"></Property>
	<Property Name="LeafName" Type="Null"></Property>
	<Property Name="UnderlyingObjectType" Type="Number">0</Property>
	</Parameter>
	</Parameters>
	</Method>
	<Method Id="50" ParentId="6" Name="AddItem">
	<Parameters>
	<Parameter TypeId="{54cdbee5-0897-44ac-829f-411557fa11be}">
	<Property Name="FolderUrl" Type="Null"></Property>
	<Property Name="LeafName" Type="Null"></Property>
	<Property Name="UnderlyingObjectType" Type="Number">0</Property>
	</Parameter>
	</Parameters>
	</Method>
	<Method Id="55" ParentId="6" Name="AddItem">
	<Parameters>
	<Parameter TypeId="{54cdbee5-0897-44ac-829f-411557fa11be}">
	<Property Name="FolderUrl" Type="Null"></Property>
	<Property Name="LeafName" Type="Null"></Property>
	<Property Name="UnderlyingObjectType" Type="Number">0</Property>
	</Parameter>
	</Parameters>
	</Method>
	<Method Id="60" ParentId="6" Name="AddItem">
	<Parameters>
	<Parameter TypeId="{54cdbee5-0897-44ac-829f-411557fa11be}">
	<Property Name="FolderUrl" Type="Null"></Property>
	<Property Name="LeafName" Type="Null"></Property>
	<Property Name="UnderlyingObjectType" Type="Number">0</Property>
	</Parameter>
	</Parameters>
	</Method>
	<Identity Id="6" Name="740c6a0b-85e2-48a0-a494-e0f1759d4aa7:site:5b2a524b-edc8-4da9-8904-4d28943abb39:web:26fc0fbf-d565-4c81-a9f5-ac858f67255a:list:a1e33484-c701-484e-8023-3ad360c23022"></Identity>
	</ObjectPaths>
	</Request>

view raw batchadd.xml hosted with ❤ by GitHub

Hope you enjoyed this blog post. Happy SharePointing!

Addendum: I would also like to point out one of the hidden gems of the SharePoint world: if you are using Server Side Code (Full Trust), there is a similar batch method available called SPWeb.ProcessBatchData which can be used to bulk add, edit and delete list items. This is really helpful because it can operate on large number of items at once without making repeated calls to the database.

Convert a SharePoint WebApplication from Classic authentication to Claims

Here is a quick Powershell script to convert a SharePoint WebApplication from Classic (Windows) Authentication to Claims Authentication. This script is tested in SharePoint 2010 only.

When working with SharePoint 2013, you will not need this in most cases as the default authentication provider is Claims.

	$WebAppName = "http://webappurl/"
	$wa = get-SPWebApplication $WebAppName
	$wa.UseClaimsAuthentication = $true
	$wa.Update()
	$account = "domain\username"
	$account = (New-SPClaimsPrincipal -identity $account -identitytype 1).ToEncodedString()
	$wa = get-SPWebApplication $WebAppName
	$zp = $wa.ZonePolicies("Default")
	$p = $zp.Add($account,"PSPolicy")
	$fc=$wa.PolicyRoles.GetSpecialRole("FullControl")
	$p.PolicyRoleBindings.Add($fc)
	$wa.Update()
	$wa.MigrateUsers($true)
	$wa.ProvisionGlobally()

view raw claims.ps1 hosted with ❤ by GitHub