Spservices Introduction: Invoking a Web Service using a Spserivces object

spservices Introduction: Invoking a Web Service using a Spserivces objectCategory: Spserivces2014-09-21 04:23 304 People read comments (0) favorite reports In the previous article, Spservices introduced the basic methods of some spservices, in addition to these methods, the main use of spservices is to use Ajax methods to invoke the Web Service provided by SharePoint.

First look at the syntax:

[JavaScript]View Plaincopy

1. $(). Spservices ({
2. Operation: "OperationName",
3. [WebURL: "/sitepath",]
4. [Option1:value1,]
5. [Option2:value2,]
6. [Async: false,]
7. Completefunc: function (XData, Status) {
8. ... Do stuff ...
9. }
10. });

which

Operation is used to specify the name of the Web Service method, such as the GetListItems method in the most commonly used lists Web services, to get items in the list.

The Weburl is used to specify the URL that the AJAX request uses, by default the URL of the current site.

Options (OPTIONS1,OPTIONS2, etc.) are used to specify the parameters required for a Web Servcie call, and different Web services have different parameters, such as GetListItems service, need to specify Listname,viewname, and so on.

Async is used to specify whether the invocation of a Web service is asynchronous or synchronous, and the default Ajax call is asynchronous, and if you need to use Async:false to force a synchronous call to a Web service

The completefunc is used to specify a callback function that the Web service invocation succeeds.

To give a simple example, use Spservices to call the GetListItems method:

[JavaScript]View Plaincopy

2. $(). Spservices ({
4. Operation: "GetListItems",
6. WebURL:"/",
8. ListName: "Tasks",
10. Async: false,
12. Completefunc: function (XData, Status) {
14. if (Status = = ' success ')
16. {
18. alert (Xdata.responsetext);
20. }
22. }
24. });

In my environment, the result of running the above code is as shown. (Only one piece of data in the Tasks list)

You can see that we have used very little code to complete the call to the GetListItems method, and we can handle the return result in the Completefunc method. The XML data returned by the call to the Web service is saved in the Xdata.responsexml property, and in the Spserives library, two very useful methods are available to process the XML data.

One is the Spfilternode used to parse XML data.

The syntax is:

[JavaScript]View Plaincopy

1. $ (xdata.responsexml). Spfilternode (Somenode)

You can use this method to parse the XML data returned by the GetListItems method, as follows:

[JavaScript]View Plaincopy

2. $(). Spservices ({
4. Operation: "GetListItems",
6. WebURL:"/",
8. ListName: "Tasks",
10. Async: false,
12. Completefunc: function (XData, Status) {
14. if (Status = = ' success ')
16. {
18. $ (xdata.responsexml).  Spfilternode ("Z:row"). each (function (index, item) {alert (index); alert (item);});
20. }
22. }
24. });

This uses the Spfilternode method to traverse each Z:row node.

Another method is to convert the XML data to a JSON object's Spxmltojson

The syntax is:

[JavaScript]View Plaincopy

1. $ (xdata.responsexml). Spfilternode ( "Z:row"). Spxmltojson ({   
2.   mapping: {},  
3.   includeallattrs: false,    // Contains all the properties in the Z:row node   
4.   removeows: true,            //need to remove ows_ prefixes    
5.   sparse: false               //if true, Will not return an empty property value <span style= "font-family: arial, helvetica, sans-serif;" > ("") </span>  
6. });   

What you need to illustrate here is the mapping parameter, which allows you to specify the matching rules between the attributes of the XML node and the properties of the JSON object, such as the properties of the Z:row node you want to Ows_title, the name in the JSON object is "Newtitle", Type is of type string, you can add such a mapping:

[JavaScript]View Plaincopy

1. Ows_title: {mappedname: "Newtitle", ObjectType: "Text"}

Where mappedname specifies the name in the JSON object, objecttype specifies the JS object after the conversion. The corresponding conversion relationships for SharePoint Field objects and JS objects are as follows:

spfieldtype (field type)	JavaScript Object type (JS type)
Counter	Int
Integer	Int
Datetime	Date ()
User	User = {userId, userName}
Usermulti	User array
Lookup	Lookup = {lookupid, lookupvalue}
Lookupmulti	Lookup array
Boolean	True/false
Multichoice	String number
Currency	Float
Text	String

To illustrate:

[JavaScript]View Plaincopy

2. $(). Spservices ({
4. Operation: "GetListItems",
6. WebURL:"/",
8. ListName: "Tasks",
10. Async: false,
12. Completefunc: function (XData, Status) {
14. if (Status = = ' success ')
16. {
18. var Myjson = $ (xdata.responsexml). Spfilternode ("Z:row"). Spxmltojson ({
20. Mapping: {
22. ows_id: {mappedname: "ID", ObjectType: "Counter"},
24. Ows_title: {mappedname: "Newtitle", ObjectType: "Text"},
26. ows_created: {mappedname: "Created", ObjectType: "DateTime"},
28. },
30. Includeallattrs: True,
32. Removeows: false
34. });
36. alert (Myjson);
38. alert (myjson[0].id);
40. Alert (myjson[0). Newtitle);
42. Alert (myjson[0). Created);
44. }
46. }
48. });

The structure of the Myjson object after running is this:

You can see that ows_id has map to the id attribute, and the same ows_title map to the Newtitle attribute, as well as ows_created,map to the Created attribute.

In addition to the above two methods, Spservices also provides a more methodological approach: Spgetlistitemsjson

This method calls GetListItems the Web service method, directly returns a JSON object, very convenient to use, but also eliminates the mapping trouble.

Grammar:

[JavaScript]View Plaincopy

2. $(). Spservices.spgetlistitemsjson ({
4. WebURL: " ",
6. ListName: " ",
8. Camlviewname: " ",
10. Camlquery: " ",
12. Camlviewfields: " ",
14. Camlrowlimit: " ",
16. Camlqueryoptions: " ",
18. Changetoken: " ",
20. Contains: " ",
22. Mapping: NULL,
24. Mappingoverrides: null,
26. Debug: false
28. });

This will not give an example.

In addition to the above example of the GetListItems method, the Spservice library can also support a lot of Web service calls, specifically, please refer to: Click to open the link

Spservices Introduction: Invoking a Web Service using a Spserivces object