docs/core/web-services.md
---
title: 'Web Services'
function: '$().SPServices'
certification:
sp2007: 'certified'
sp2010: 'works'
certification_notes: 'See individual Web Services for specific certifications'
description: 'This is the core function of the library, which you can use to make Ajax calls to the SharePoint Web Services. Note: As of version 2013.01, all calls return a jQuery deferred object aka a promise.'
nav_sort: 1
introduced: 0.2.3
---
## Notes
As of version 2013.01, all calls return a [jQuery deferred object](http://api.jquery.com/category/deferred-object/) aka a promise.
As of v0.7.2, the core `$().SPServices()` function allows for simple caching of the XML results using jQuery promises in a similar manner to that outlined in Scot Hillier's excellent post [Utilizing Promises in SharePoint 2013 Apps](http://www.shillier.com/archive/2012/11/29/utilizing-promises-in-sharepoint-2013-apps.aspx). See the [Caching](../../caching.md) page for more details.
## Supported Web Services
The table below shows the Web Services for which we have implemented at least one operation (or have operations coming in planned releases) with a link to more detailed documentation, indicators for whether the Web Service is available in WSS 3.0 and/or MOSS, and links to the MSDN documentation pages. Note that there are some [general syntax instructions](#general-syntax) below the table.
| Web Service | WSS 3.0 | MOSS | MSDN Documentation | Foundation | SP2010 |
| ----------- | ------- | ---- | ------------------ | ---------- | ------ |
| [Alerts](web-services/Alerts.md) |  |  | [Alerts Web Service](http://msdn.microsoft.com/en-us/library/alerts.aspx) |  |  |
| [Authentication](web-services/Authentication.md) |  |  | [Authentication Web Service](http://msdn.microsoft.com/en-us/library/authentication.aspx) |  |  |
| [Copy](web-services/Copy.md) |  |  | [Copy Web Service](http://msdn.microsoft.com/en-us/library/copy.aspx) |  |  |
| [Forms](web-services/Forms.md) |  |  | [Forms Web Service](http://msdn.microsoft.com/en-us/library/forms.aspx) |  |  |
| [Lists](web-services/Lists.md) |  |  | [Lists Web Service](http://msdn.microsoft.com/en-us/library/lists.aspx) |  |  |
| [Meetings](web-services/Meetings.md) |  |  | [Meetings Web Service](http://msdn.microsoft.com/en-us/library/ms774629.aspx) |  |  |
| [People](web-services/People.md) |  |  | [People Web Service](http://msdn.microsoft.com/en-us/library/people.aspx) |  |  |
| [Permissions](web-services/Permissions.md) |  |  | [Permissions Web Service](http://msdn.microsoft.com/en-us/library/permissions.aspx) |  |  |
| [SiteData](web-services/SiteData.md) |  |  | [SiteData Web Service](http://msdn.microsoft.com/en-us/library/ms774821%28v=office.12%29.aspx) |  |  |
| [Sites](web-services/Sites.md) |  |  | Sites Web Service [2007](http://msdn.microsoft.com/en-us/library/ms774847%28v=office.12%29.aspx) [2010](http://msdn.microsoft.com/en-us/library/bb250173.aspx) |  |  |
| [UserGroup (Users and Groups)](web-services/UserGroup.md) |  |  | [Users and Groups Web Service](http://msdn.microsoft.com/en-us/library/ms772647.aspx) |  |  |
| [Versions](web-services/Versions.md) |  |  | [Versions Web Service](http://msdn.microsoft.com/en-us/library/ms772545.aspx) |  |  |
| [Views](web-services/Views.md) |  |  | [Views Web Service](http://msdn.microsoft.com/en-us/library/views.aspx) |  |  |
| [WebPartPages](web-services/WebPartPages.md) |  |  | [Web Part Pages Web Service](http://msdn.microsoft.com/en-us/library/ms774569.aspx) |  |  |
| [Webs](web-services/Webs.md) |  |  | [Webs Web Service](http://msdn.microsoft.com/en-us/library/webs.aspx) |  |  |
| [PublishedLinksService](web-services/PublishedLinksService.md) | |  | [Published Links Web Service](http://msdn.microsoft.com/en-us/library/aa981003.aspx) | |  |
| [RecordsRepository (Official File)](web-services/RecordsRepository.md) | |  | [Official File Web Service](http://msdn.microsoft.com/en-us/library/aa981147%28v=office.12%29.aspx) | |  |
| [QueryService (Search)](web-services/QueryService.md) | |  | [Search Web Service](http://msdn.microsoft.com/en-us/library/search.aspx) | |  |
| [SpellChecker](web-services/SpellChecker.md) | |  | [SpellChecker Web Service](http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.publishing.spellchecker.spellcheck.aspx) | |  |
| [UserProfileService](web-services/UserProfileService.md) | |  | [User Profile Web Service](http://msdn.microsoft.com/en-us/library/aa981571.aspx) | |  |
| [Workflow](web-services/Workflow.md) | |  | [Workflow Web Service](http://msdn.microsoft.com/en-us/library/aa981383.aspx) | |  |
| [Diagnostics](web-services/Diagnostics.md) | | | [Diagnostics Web Service](http://msdn.microsoft.com/en-us/library/ee551419.aspx) |  |  |
| [SocialDataService](web-services/SocialDataService.md) | | | [SocialDataService Web Service](http://msdn.microsoft.com/en-us/library/ee590294.aspx) | |  |
| [TaxonomyClientService](web-services/TaxonomyClientService.md) | | | [TaxonomyClientService Web Service](http://msdn.microsoft.com/en-us/library/ee586638.aspx) | |  |
## General Syntax
```javascript
$().SPServices({
operation: "operationname",
[webURL: "/sitepath",]
[option1: value1,]
[option2: value2,]
[async: false,]
completefunc: function (xData, Status) {
//...do stuff...
}
});
```
_operation_
The name of the Web Service operation (see the SDK documentation links above). Because the Web Services operations are named uniquely, you only need to specify the operation.
_webURL_
For Web Service operations where it makes sense, you can pass in a webURL to change the context for the AJAX call. By default, the current site (as determined by [$().SPServices.SPGetCurrentSite](../../utilities/SPGetCurrentSite.md)) is used.
_options_
The options vary based on which Web Service and operation you are calling. In all instances, the options will take the same names as those described in the SDK.
_async_
By default, all of the Web Service operations are called asynchronously with AJAX. Generally, this will be the desired approach, but to force synchronicity, add the async: false option.
_cacheXML_
If set to true, the result's raw XML will be cached using jQuery promises in a similar manner to that outlined in Scot Hillier's excellent post [Utilizing Promises in SharePoint 2013 Apps](http://www.shillier.com/archive/2012/11/29/utilizing-promises-in-sharepoint-2013-apps.aspx). See more about how this works on the [Caching](../../caching.md) page.
_completefunc_
A function to call on completion of the AJAX call to the Web Service:
```javascript
completefunc: function(xData, Status) {
//...do something...
},
```
## Example
Example call for GetListItems. This example is taken directly from SPCascadeDropdowns:
```javascript
$().SPServices({
operation: "GetListItems",
// Force sync so that we have the right values for the child column onchange trigger
async: false,
webURL: opt.relationshipWebURL,
listName: opt.relationshipList,
// Filter based on the currently selected parent column's value
CAMLQuery: camlQuery,
// Only get the parent and child columns
CAMLViewFields: "<ViewFields><FieldRef Name='" + opt.relationshipListParentColumn + "' /><FieldRef Name='" + opt.relationshipListChildColumn + "' /></ViewFields>",
// Override the default view rowlimit and get all appropriate rows
CAMLRowLimit: 0,
completefunc: function(xData, Status) {
// ...
}
});
```
Example call for GetUserInfo:
```javascript
waitMessage = "<table width='100%' align='center'><tr><td align='center'><img src='/_layouts/images/gears_an.gif'/></td></tr></table>";
$("#WSOutput").html(waitMessage).SPServices({
operation: "GetUserInfo",
userLoginName: "SHARE1\\demouser",
completefunc: function (xData, Status) {
$("#WSOutput").html("").append("<b>This is the output from the GetUserInfo operation:</b>");
$(xData.responseXML).find("User").each(function() {
$("#WSOutput").append("<li>ID: " + $(this).attr("ID") + "</li>");
$("#WSOutput").append("<li>Sid: " + $(this).attr("Sid") + "</li>");
$("#WSOutput").append("<li>Name: " + $(this).attr("Name") + "</li>");
$("#WSOutput").append("<li>LoginName: " + $(this).attr("LoginName") + "</li>");
$("#WSOutput").append("<li>Email: " + $(this).attr("Email") + "</li>");
$("#WSOutput").append("<li>Notes: " + $(this).attr("Notes") + "</li>");
$("#WSOutput").append("<li>IsSiteAdmin: " + $(this).attr("IsSiteAdmin") + "</li>");
$("#WSOutput").append("<li>IsDomainGroup: " + $(this).attr("IsDomainGroup") + "</li>");
$("#WSOutput").append("<hr/>");
});
}
});
```