From a0b44575deacd39e0326c14c61f5e4fa9ac989cf Mon Sep 17 00:00:00 2001 From: Anna Samoryadova Date: Tue, 27 Sep 2011 11:20:15 +0400 Subject: [PATCH] update API page --- www/api.html | 880 ++++++++++++++++++++++++++++------------------------------ 1 file changed, 420 insertions(+), 460 deletions(-) diff --git a/www/api.html b/www/api.html index a57f5d5..aaf0b7c 100644 --- a/www/api.html +++ b/www/api.html @@ -90,61 +90,59 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa

Enumerations

Error codes

- 
enum error_type {
-	FAILURE, // Function finished with error
-	SUCCESS, // Function finished without error
-	ERROR_ALLOCATION_OF_MEMORY, // Allocation of memory
-     	ERROR_NO_FUNCTION, // Defining function error
-     	ERROR_INITIALIZATION_ALREADY_PASSED, // Re-initialization error
-     	ERROR_IS_BUSY, // Module is busy
-     	ERROR_SEND_DATA, // Data sending error
-     	ERROR_PARSE_DATA // Data parsing error
-}
+	
enum error_type {
+	FAILURE, // Function finished with error
+	SUCCESS, // Function finished without error
+	ERROR_ALLOCATION_OF_MEMORY, // Allocation of memory
+     	ERROR_NO_FUNCTION, // Defining function error
+     	ERROR_INITIALIZATION_ALREADY_PASSED, // Re-initialization error
+     	ERROR_IS_BUSY, // Module is busy
+     	ERROR_SEND_DATA, // Data sending error
+     	ERROR_PARSE_DATA // Data parsing error
+}
 	

 
 	
Driver interface

 	
MySocials driver interface described in  msa_module structure. Some of the fields of this stucture are filled before initialization by application (marked with **), the rest of it is filled during initialization.

-	
-	struct msa_module {
-	gchar *id;    // Identifier 
-   	gchar *name;  // External driver name
-   	gchar* driverName;       // Driver name for system purposes (equals driver identifier)
-   	gchar *pic;   // Icon coded in base64
-   	gchar *proxy;  // **Proxy server address or NULL
-   	gint port; // **Proxy server port
-   
-   	/* Pointer to function for processing requests.
+
+	
struct msa_module {
+	gchar *id;    // Identifier 
+   	gchar *name;  // External driver name
+   	gchar* driverName;       // Driver name for system purposes (equals driver identifier)
+   	gchar *pic;   // Icon coded in base64
+   	gchar *proxy;  // **Proxy server address or NULL
+   	gint port; // **Proxy server port
+ 
+   	/* Pointer to function for processing requests.
       	   Parameters:
            xmlRequest — request in XML format
            xmlResponse — response in XML format
            info — structure with driver settings
-      
+ 
 	   Function returns  SUCCESS in case without errors, otherwise FAILURE. 
-   	*/
-   
-   	error_type (*send)(char* xmlRequest, char** xmlResponse, struct msa_module *info) 
-        
-   	/* Pointer to function for driver shutting down.
+   	*/
+ 
+   	error_type (*send)(char* xmlRequest, char** xmlResponse, struct msa_module *info) 
+ 
+   	/* Pointer to function for driver shutting down.
            Parameters:
            info — structure with driver settings
-      
+ 
 	   Function returns  SUCCESS in case without errors, otherwise FAILURE. 
-   	*/
-
-   	error_type (*shutdown)(struct msa_module* info);
-}
-
+   	*/
+ 
+   	error_type (*shutdown)(struct msa_module* info);
+}
 	

 
 	
Format of XML requests and responses

 	
Common format of driver request and response

 	
Request format

-	
-	<Request class="" function="" noAuthorize="true">
-      		<Params>
-
-        	</Params>
-	</Request>
+	
<Request class="" function="" noAuthorize="true">
+      	<Params>
+ 
+        </Params>
+</Request>
 	

 
 	
    
@@ -155,12 +153,11 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	

 
 	
Response format

-	
-	<Response class="" function="" authorized="true" upload="..." download="...">
-      		<Params>
-
-        	</Params>
-	</Response>
+	
<Response class="" function="" authorized="true" upload="..." download="...">
+      	<Params>
+ 
+        </Params>
+</Response>
 	

 	
 	
    
@@ -182,128 +179,119 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
	
 	

 
+	
 	
Settings

 	
getSettings

 	Request:
-	
-	<Request class="settings" function="getSettings">
-      		<Params/>
-        </Request>
+	
<Request class="settings" function="getSettings">
+      	<Params/>
+</Request>
 	

 
 	Response:
-	
-	<Response class="settings" function="getSettings">
-      		<Params>
-			<string name="mid"> ... </string>
-			<string name="sid"> ... </string>
-			<string name="secret"> ... </string>
-        	</Params>
-	</Response>
+	
<Response class="settings" function="getSettings">
+      	<Params>
+		<string name="mid"> ... </string>
+		<string name="sid"> ... </string>
+		<string name="secret"> ... </string>
+        </Params>
+</Response>
 	

 	
Content of Params tag depends on the driver. It is recommended to save content of Params tag and send it to setup function without any changes.

 
 	
setSettings

 	Request:
-	
-	<Request class="settings" function="setSettings">
-      		<Params>
-			<string name="mid"> ... </string>
-			<string name="sid"> ... </string>
-			<string name="secret"> ... </string>
-        	</Params>
-	</Request>
+	
<Request class="settings" function="setSettings">
+      	<Params>
+		<string name="mid"> ... </string>
+		<string name="sid"> ... </string>
+		<string name="secret"> ... </string>
+        </Params>
+</Request>
 	

 	
Params tag must contain data received from driver during getSettings request.

 	Response: info message or error message.
 
 	
getListMethods

 	Request:
-	
-	<Request class="settings" function="getListMethods">
-      		<Params/>
-        </Request>
+	
<Request class="settings" function="getListMethods">
+  	<Params/>
+</Request>
 	

 	Response:
-	
-	<Response class="settings" function="getListMethods">
-      		<Params>
-			<string function="..." class="..."> ... </string>
-			<string function="..." class="..."> ... </string>
-			...
-        	</Params>
-	</Response>
+	
<Response class="settings" function="getListMethods">
+      	<Params>
+		<string function="..." class="..."> ... </string>
+		<string function="..." class="..."> ... </string>
+		...
+        </Params>
+</Response>
 	

 		
 	
testConnection

 	Request:
-	
-	<Request class="settings" function="testConnection">
-      		<Params/>
-        </Request>
+	
<Request class="settings" function="testConnection">
+      	<Params/>
+</Request>
 	

 	Response: info message or error message.
+	
 
-
-
+	
 	
Profile

 	
getProfile

 	Request:
-	
-	<Request class="profile" function="getProfile">
-      		<Params id="...">
-        </Request>
+	
<Request class="profile" function="getProfile">
+      	<Params id="...">
+</Request>
 	

 	
Attribute id is an id of user whose profile is needed to be received (optional, equals id of owner of current account by default).

 	Response:
-	
-	<Response class="profile" function="getProfile">
-      		<Params id="...">
-			<string name="FirstName"> ... </string>
-            		<string name="NickName"> ... </string>
-            		<string name="LastName"> ... </string>
-            		<string name="Gender"> ... </string>
-            		<string name="Birthday"> ... </string>
-            		<string name="MobilePhone"> ... </string>
-            		<string name="HomePhone"> ... </string>
-            		<img name="Img"> ... </img>
-            		<string name="CityName"> ... </string>
-            		<string name="CountryName"> ... </string>
-        	</Params>
-	</Response>
+	
<Response class="profile" function="getProfile">
+      	<Params id="...">
+		<string name="FirstName"> ... </string>
+        	<string name="NickName"> ... </string>
+        	<string name="LastName"> ... </string>
+        	<string name="Gender"> ... </string>
+        	<string name="Birthday"> ... </string>
+        	<string name="MobilePhone"> ... </string>
+        	<string name="HomePhone"> ... </string>
+        	<img name="Img"> ... </img>
+        	<string name="CityName"> ... </string>
+        	<string name="CountryName"> ... </string>
+        </Params>
+</Response>
 	

 
 	
getBaseProfile

 	Request:
-	
-	<Request class="profile" function="getBaseProfile">
-      		<Params id="...">
-        </Request>
+	
<Request class="profile" function="getBaseProfile">
+      	<Params id="...">
+</Request>
+ 
 	

 	
Attribute id is an id of user whose profile is needed to be received (optional, equals id of owner of current account by default).

 	Response:
-	
-	<Response class="profile" function="getBaseProfile">
-      		<Params id="...">
-			<string name="FirstName"> ... </string>
-            		<string name="NickName"> ... </string>
-            		<string name="LastName"> ... </string>
-            	</Params>
-	</Response>
+	
<Response class="profile" function="getBaseProfile">
+      	<Params id="...">
+		<string name="FirstName"> ... </string>
+        	<string name="NickName"> ... </string>
+        	<string name="LastName"> ... </string>
+        </Params>
+</Response>
 	

+	
 
-
-
+	
 	
Friends

 	
getListFriends

 	Request:
-	
-	<Request class="friends" function="getListFriends">
-      		<Params id="...">
-			<number name="page"> ... </number>
-			<number name="pageSize"> ... </number>
-		</Params>
-        </Request>
+	
<Request class="friends" function="getListFriends">
+      	<Params id="...">
+		<number name="page"> ... </number>
+		<number name="pageSize"> ... </number>
+	</Params>
+</Request>
 	

 	
    
 	
  • page - number of page that is requested (optional, positive integer, equals 1 by default)
    • 
@@ -311,44 +299,41 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • id - user id (optional, equals id of owner of current account by default) 
    • 
 	

 	Response:
-	
-	<Response class="friends" function="getListFriends">
-      		<Params id="...">
-			<array name="contactList" page="..." pageSize="..." quantity="...">
-				<struct name="contact" id="...">
-					<string name="FirstName"> ... </string>
-            				<string name="NickName"> ... </string>
-            				<string name="LastName"> ... </string>
-					<string name="FriendStatus"> ... </string>
-                     			<img name="Img"> ... </img>
-				</struct>
-			</array>
-            	</Params>
-	</Response>
+	
<Response class="friends" function="getListFriends">
+      	<Params id="...">
+		<array name="contactList" page="..." pageSize="..." quantity="...">
+			<struct name="contact" id="...">
+				<string name="FirstName"> ... </string>
+        			<string name="NickName"> ... </string>
+        			<string name="LastName"> ... </string>
+				<string name="FriendStatus"> ... </string>
+               			<img name="Img"> ... </img>
+			</struct>
+		</array>
+        </Params>
+</Response>
 	

 
 	
deleteFriend

 	Request:
-	
-	<Request class="friends" function ="deleteFriend">
-      		<Params id="..."/>
-        </Request>
+	
<Request class="friends" function ="deleteFriend">
+      	<Params id="..."/>
+</Request>
 	

 	Response: info message or error message.
+	
 
-
-
+	
 	
Photos

 	
createAlbum

 	Request:
-	
-	<Request class="photos" function="createAlbum">
-      		<Params id="...">
-			<string name="name"> ... </string>
-            		<string name="description"> ... </string>
-            		<string name="privacy">PRIVACY</string>
-		</Params>
-        </Request>
+	
<Request class="photos" function="createAlbum">
+      	<Params id="...">
+		<string name="name"> ... </string>
+        	<string name="description"> ... </string>
+        	<string name="privacy">PRIVACY</string>
+	</Params>
+</Request>
 	

 	PRIVACY can have following values: 
 	
    
@@ -364,58 +349,54 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • description - optional 
    • 
 	

 	Response:
-	
-	<Response class="photos" function="createAlbum">
-      		<Params id="...">
-			<string name="albumId"> ... </string>
-            	</Params>
-	</Response>
+	
<Response class="photos" function="createAlbum">
+      	<Params id="...">
+		<string name="albumId"> ... </string>
+        </Params>
+</Response>
 	

 
 	
getListAlbums

 	Request:
-	
-	<Request class="photos" function="getListAlbums">
-      		<Params id="..."/>
-        </Request>
+	
<Request class="photos" function="getListAlbums">
+      	<Params id="..."/>
+</Request>
 	

 	
id - optional, equals id of owner of current account by default.

 	Response:
-	
-	<Response class="photos" function="getListAlbums">
-      		<Params>
-			<array name="albumList" quantity="..." ownerId="...">
-				<struct name="album" id="...">
-					<string name="title"> ... </string>
-            				<string name="description"> ... </string>
-            				<string name="thumbId"> ... </string>
-					<img name="Img"> ... </img>
-					<number name="created"> ... </number>
-                     			<number name="updated"> ... </number>
-					<number name="size"> ... </number>
-					<number name="canUpload"> ... </number>
-				</struct>
-			</array>
-            	</Params>
-	</Response>
+	
<Response class="photos" function="getListAlbums">
+      	<Params>
+		<array name="albumList" quantity="..." ownerId="...">
+			<struct name="album" id="...">
+				<string name="title"> ... </string>
+        			<string name="description"> ... </string>
+        			<string name="thumbId"> ... </string>
+				<img name="Img"> ... </img>
+				<number name="created"> ... </number>
+               			<number name="updated"> ... </number>
+				<number name="size"> ... </number>
+				<number name="canUpload"> ... </number>
+			</struct>
+		</array>
+        </Params>
+</Response>
 	

 	
canUpload - optional, if this parameter isn't set, it means that album is available for current user.

 
 	
uploadPhoto

 	Request:
-	
-	<Request class="photos" function = "uploadPhoto">
-     		<Params>
-         		<string name="albumId"> ... </string>
-         		<string name="albumName"> ... </string>
-         		<string name="albumPrivacy"> ... </string>
-         		<string name="albumDescription"> ... </string>
-         		<string name="file"> ... </string>
-         		<string name="fileName"> ... </string>
-         		<string name="description"> ... </string>
-         		<string name="tags"> ... </string>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "uploadPhoto">
+     	<Params>
+        	<string name="albumId"> ... </string>
+        	<string name="albumName"> ... </string>
+        	<string name="albumPrivacy"> ... </string>
+        	<string name="albumDescription"> ... </string>
+        	<string name="file"> ... </string>
+        	<string name="fileName"> ... </string>
+        	<string name="description"> ... </string>
+        	<string name="tags"> ... </string>
+     	</Params>
+</Request>
 	

 	
    
 	
  • There have to be only one of parameters albumName or albumId in request.
    • 
@@ -427,25 +408,23 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • Parameter fileName contains name of file for upload.
    • 
 	

 	Response:
-	
-	<Response class="photos" function = "uploadPhoto">
-     		<Params>
-         		<string name="albumId"> ... </string>
-        		<string name="photoId"> ... </string>
-     		</Params>
-	</Response>
+	
<Response class="photos" function = "uploadPhoto">
+     	<Params>
+        	<string name="albumId"> ... </string>
+        	<string name="photoId"> ... </string>
+     	</Params>
+</Response>
 	

 
 	
getListPhotos

 	Request:
-	
-	<Request class="photos" function = "getListPhotos">
-     		<Params id="...">
-        		<string name="albumId"> ... </string>
-        		<number name="page"> ... </number>
-        		<number name="pageSize"> ... </number>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "getListPhotos">
+     	<Params id="...">
+        	<string name="albumId"> ... </string>
+        	<number name="page"> ... </number>
+        	<number name="pageSize"> ... </number>
+     	</Params>
+</Request>
 	

 	
    
 	
  • page - number of page that is requested (optional, positive integer, equals 1 by default)
    • 
@@ -453,31 +432,29 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • id - user id (optional, equals id of owner of current account by default) 
    • 
 	

 	Response:
-	
-	<Response class="photos" function="getListPhotos">
-    		<Params>
-        		<array name="photosList" page="..." pageSize="..." quantity="..." ownerId="..." albumId="...">
-            			<struct name="photo" id="..."/>
-                			<string name="urlSmall"> ... </string>
-               				<string name="urlBig"> ... </string>
-                			<string name="urlOrig"> ... </string>
-                			<string name="description"> ... </string>
-                			<number name="created"> ... </number>
-            			</struct>
-        		</array>
-    		</Params>
-	</Response>
+	
<Response class="photos" function="getListPhotos">
+    	<Params>
+        	<array name="photosList" page="..." pageSize="..." quantity="..." ownerId="..." albumId="...">
+        		<struct name="photo" id="..."/>
+               			<string name="urlSmall"> ... </string>
+        			<string name="urlBig"> ... </string>
+               			<string name="urlOrig"> ... </string>
+               			<string name="description"> ... </string>
+               			<number name="created"> ... </number>
+        		</struct>
+        	</array>
+    	</Params>
+</Response>
 	

 
 	
getListUserPhotos

 	Request:
-	
-	<Request class="photos" function = "getListUserPhotos">
-     		<Params id="...">
-        		<number name="page"> ... </number>
-        		<number name="pageSize"> ... </number>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "getListUserPhotos">
+     	<Params id="...">
+        	<number name="page"> ... </number>
+        	<number name="pageSize"> ... </number>
+     	</Params>
+</Request>
 	

 	
    
 	
  • page - number of page that is requested (optional, positive integer, equals 1 by default)
    • 
@@ -485,60 +462,57 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • id - user id (optional, equals id of owner of current account by default) 
    • 
 	

 	Response:
-	
-	<Response class="photos" function="getListUserPhotos">
-   		<Params>
-        		<array name="photosList" page="..." pageSize="..." quantity="...">
-            			<struct name="photo" id="..."/>
-                			<string name="ownerId"> ... </string>
-                			<string name="albumId"> ... </string>
-                			<string name="urlSmall"> ... </string>
-                			<string name="urlBig"> ... </string>
-                			<string name="urlOrig"> ... </string>
-                			<string name="description"> ... </string>
-                			<number name="created"> ... </number>
-            			</struct>
-        		</array>
-    		</Params>
-	</Response>
+	
<Response class="photos" function="getListUserPhotos">
+   	<Params>
+        	<array name="photosList" page="..." pageSize="..." quantity="...">
+        		<struct name="photo" id="..."/>
+               			<string name="ownerId"> ... </string>
+               			<string name="albumId"> ... </string>
+               			<string name="urlSmall"> ... </string>
+               			<string name="urlBig"> ... </string>
+               			<string name="urlOrig"> ... </string>
+               			<string name="description"> ... </string>
+               			<number name="created"> ... </number>
+        		</struct>
+        	</array>
+    	</Params>
+</Response>
 	

 
 	
getListPhotoTags

 	Request:
-	
-	<Request class="photos" function = "getListPhotoTags">
-     		<Params>
-                	<string name="ownerId"> ... </string>
-                	<string name="albumId"> ... </string>
-                	<string name="photoId"> ... </string>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "getListPhotoTags">
+     	<Params>
+               	<string name="ownerId"> ... </string>
+               	<string name="albumId"> ... </string>
+               	<string name="photoId"> ... </string>
+     	</Params>
+</Request>
 	

 	Response:
-	
-	<Response class="photos" function="getListPhotoTags">
-    		<Params>
-        		<array name="tagsList" quantity="..." ownerId="..." albumId="..." photoId="...">
-            			<struct name="tag" id="..."/>
-                			<string name="userId"> ... </string>
-                			<string name="text"> ... </string>
-                			<number name="created"> ... </number>
-            			</struct>
-        		</array>
-    		</Params>
-	</Response>
+	
<Response class="photos" function="getListPhotoTags">
+    	<Params>
+        	<array name="tagsList" quantity="..." ownerId="..." albumId="..." photoId="...">
+        		<struct name="tag" id="..."/>
+               			<string name="userId"> ... </string>
+               			<string name="text"> ... </string>
+               			<number name="created"> ... </number>
+        		</struct>
+        	</array>
+    	</Params>
+</Response>
 	

+
 	
Parameter userId is an id of user which is marked on photo (optional).

 
 	
getListFavoritePhotos

 	Request:
-	
-	<Request class="photos" function = "getListFavoritePhotos">
-     		<Params id="...">
-        		<number name="page"> ... </number>
-        		<number name="pageSize"> ... </number>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "getListFavoritePhotos">
+     	<Params id="...">
+        	<number name="page"> ... </number>
+        	<number name="pageSize"> ... </number>
+     	</Params>
+</Request>
 	

 	
    
 	
  • page - number of page that is requested (optional, positive integer, equals 1 by default)
    • 
@@ -546,98 +520,92 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • id - user id (optional, equals id of owner of current account by default) 
    • 
 	

 	Response:
-	
-	<Response class="photos" function="getListFavoritePhotos">
-    		<Params>
-        		<array name="photosList" page="..." pageSize="..." quantity="...">
-            			<struct name="photo" id="..."/>
-                			<string name="ownerId"> ... </string>
-                			<string name="albumId"> ... </string>
-                			<string name="urlSmall"> ... </string>
-                			<string name="urlBig"> ... </string>
-                			<string name="urlOrig"> ... </string>
-                			<string name="description"> ... </string>
-                			<number name="created"> ... </number>
-            			</struct>
-        		</array>
-    		</Params>
-	</Response>
+	
<Response class="photos" function="getListFavoritePhotos">
+    	<Params>
+        	<array name="photosList" page="..." pageSize="..." quantity="...">
+        		<struct name="photo" id="..."/>
+               			<string name="ownerId"> ... </string>
+               			<string name="albumId"> ... </string>
+               			<string name="urlSmall"> ... </string>
+               			<string name="urlBig"> ... </string>
+               			<string name="urlOrig"> ... </string>
+               			<string name="description"> ... </string>
+               			<number name="created"> ... </number>
+        		</struct>
+        	</array>
+    	</Params>
+</Response>
 	

 
 	
getPhoto

 	Request:
-	
-	<Request class="photos" function = "getPhoto">
-     		<Params>
-        		<string name="url"> ... </string>
-        		<string name="path"> ... </string>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "getPhoto">
+     	<Params>
+        	<string name="url"> ... </string>
+        	<string name="path"> ... </string>
+     	</Params>
+</Request>
 	

 	Response: info message or error message.
 
 	
getListPhotoComments

 	Request:
-	
-	<Request class="photos" function = "getListPhotoComments">
-     		<Params>
-        		<string name="ownerId"> ... </string>
-       			<string name="albumId"> ... </string>
-        		<string name="photoId"> ... </string>
-        		<number name="page"> ... </number>
-        		<number name="pageSize"> ... </number>
-     		</Params>
-	</Request>
+	
<Request class="photos" function = "getListPhotoComments">
+     	<Params>
+        	<string name="ownerId"> ... </string>
+       		<string name="albumId"> ... </string>
+        	<string name="photoId"> ... </string>
+        	<number name="page"> ... </number>
+        	<number name="pageSize"> ... </number>
+     	</Params>
+</Request>
 	

 	
    
 	
  • page - number of page that is requested (optional, positive integer, equals 1 by default)
    • 
 	
  • pageSize - page size (optional, positive integer, equals 100 by default)
    • 
 	

 	Response:
-	
-	<Response class="photos" function="getListPhotoComments">
-    		<Params>
-        		<array name="commentsList" page="..." pageSize="..."  quantity="..." ownerId="..." albumId="..." photoId="...">
-            			<struct name="comment" id="..."/>
-                			<string name="ParentId"> ... </string>
-                			<string name="SenderId"> ... </string>
-                			<string name="SenderName"> ... </string>
-                			<string name="Time"> ... </string>
-                			<string name="Text"> ... </string>
-            			</struct>
-        		</array>
-    		</Params>
-	</Response>
+	
<Response class="photos" function="getListPhotoComments">
+    	<Params>
+        	<array name="commentsList" page="..." pageSize="..."  quantity="..." ownerId="..." albumId="..." photoId="...">
+        		<struct name="comment" id="..."/>
+               			<string name="ParentId"> ... </string>
+               			<string name="SenderId"> ... </string>
+               			<string name="SenderName"> ... </string>
+               			<string name="Time"> ... </string>
+               			<string name="Text"> ... </string>
+        		</struct>
+        	</array>
+    	</Params>
+</Response>
 	

 	
Parameter ParentId is an id of previous comment, if there is such one  (optional).

 
 	
sendPhotoComment

 	Request:
-	
-	<Request class="photos" function="sendPhotoComment">
-     		<Params>
-        		<string name="ownerId"> ... </string>
-        		<string name="albumId"> ... </string>
-        		<string name="photoId"> ... </string>
-        		<string name="text"> ... </string>
-     		</Params>
-	</Request>
+	
<Request class="photos" function="sendPhotoComment">
+     	<Params>
+        	<string name="ownerId"> ... </string>
+        	<string name="albumId"> ... </string>
+        	<string name="photoId"> ... </string>
+        	<string name="text"> ... </string>
+     	</Params>
+</Request>
 	

 	Response: info message or error message.
-	
-
+	
 
+	
 	
Messages

 	
getListOutboxMessages

 	Request:
-	
-	<Request class="messages" function="getListOutboxMessages">
-     		<Params>
-        		<number name="page"> ... </number>
-        		<number name="pageSize"> ... </number>
-          		<number name="timeOffset"> ... </number>
-     		</Params>
-	</Request>
+	
<Request class="messages" function="getListOutboxMessages">
+     	<Params>
+        	<number name="page"> ... </number>
+        	<number name="pageSize"> ... </number>
+        	<number name="timeOffset"> ... </number>
+     	</Params>
+</Request>
 	

 	
    
 	
  • page - number of page that is requested (optional, positive integer, equals 1 by default)
    • 
@@ -645,151 +613,143 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
 	
  • timeOffset - time offset for requested messages
    • 
 	

 	Response:
-	
-	<Response class="messages" function = "getListOutboxMessages">              
-      		<Params>
-            		<array name="messageList" page="..." pageSize="..." quantity="...">
-                 		<struct name="message" id="...">             
-                       			<string name="SenderId"> ... </string>
-                       			<string name="SenderName"> ... </string>
-                       			<array name="recipientList" quantity="...">
-                             			<struct name="recipient">
-                                  			<string name="RecipientId"> ... </string>
-                                   			<string name="RecipientName"> ... </string>
-                             			</struct>
-                       			</array>
-                       			<string name="Time"> ... </string>
-                       			<string name="Title"> ... </string>
-                       			<string name="Text"> ... </string>
-                       			<string name="Status"> ... </string>
-                       			<attachment id="..." ownerId="..." type="...">
-                       			 ...
-                       			</attachment>
-                 		</struct>
-             		</array>
-       		</Params>
-	</Response>
+	
<Response class="messages" function = "getListOutboxMessages">              
+      	<Params>
+        	<array name="messageList" page="..." pageSize="..." quantity="...">
+               		<struct name="message" id="...">             
+               			<string name="SenderId"> ... </string>
+               			<string name="SenderName"> ... </string>
+               			<array name="recipientList" quantity="...">
+                       			<struct name="recipient">
+                               			<string name="RecipientId"> ... </string>
+                               			<string name="RecipientName"> ... </string>
+                       			</struct>
+               			</array>
+               			<string name="Time"> ... </string>
+               			<string name="Title"> ... </string>
+               			<string name="Text"> ... </string>
+               			<string name="Status"> ... </string>
+               			<attachment id="..." ownerId="..." type="...">
+               			 ...
+               			</attachment>
+               		</struct>
+        	</array>
+       	</Params>
+</Response>
 	

 	
Parameter attachment is optional, its content depends on attribute type and can have following values:

-	
-	<attachment id="..." ownerId="..." type="image">
-        	<string name="name"> ... </string>      
-        	<string name="albumId"> ... </string>
-                <string name="urlSmall"> ... </string>
-                <string name="urlBig"> ... </string>
-        </attachment>
-
-	<attachment id="..." ownerId="..." type="video">
-        	<string name="name"> ... </string>
-        	<string name="url"> ... </string>
-                <number name="duration"> ... </number>
-                <string name="urlImage"> ... </string>
-        </attachment>
-
-	<attachment id="..." ownerId="..." type="audio">
-		<string name="name"> ... </string>
-		<string name="url"> ... </string>
-		<number name="duration"> ... </number>
-        </attachment>
-
-	<attachment id="..." ownerId="..." type="link">
-       		<string name="name"> ... </string>
-                <string name="url"> ... </string>
-                <string name="urlImage"> ... </string>
-        </attachment>
-
-	<attachment id="..." ownerId="..." type="note">
-		<string name="name"> ... </string>
-		<string name="url"> ... </string>
-	</attachment>
-	

-
-
-
-
-
+	
<attachment id="..." ownerId="..." type="image">
+        <string name="name"> ... </string>      
+        <string name="albumId"> ... </string>
+        <string name="urlSmall"> ... </string>
+        <string name="urlBig"> ... </string>
+</attachment>
+ 
+<attachment id="..." ownerId="..." type="video">
+        <string name="name"> ... </string>
+        <string name="url"> ... </string>
+        <number name="duration"> ... </number>
+        <string name="urlImage"> ... </string>
+</attachment>
+ 
+<attachment id="..." ownerId="..." type="audio">
+	<string name="name"> ... </string>
+	<string name="url"> ... </string>
+	<number name="duration"> ... </number>
+</attachment>
+ 
+<attachment id="..." ownerId="..." type="link">
+	<string name="name"> ... </string>
+	<string name="url"> ... </string>
+	<string name="urlImage"> ... </string>
+</attachment>
+ 
+<attachment id="..." ownerId="..." type="note">
+	<string name="name"> ... </string>
+	<string name="url"> ... </string>
+</attachment>
+	

+
+	
+
+	
 	
Audio

 	
getListAudio

 	Request:
-	
-	<Request class="audio" function="getListAudio">
-      		<Params id="...">
-		</Params>
-        </Request>
+	
<Request class="audio" function="getListAudio">
+      	<Params id="...">
+	</Params>
+</Request>
 	

 	Response:
-	
-	<Response class="audio" function="getListAudio">
-      		<Params id="...">
-			<array name="audioList" quantity="..." ownerId="...">
-				<struct name="audio" id="...">
-					<string name="title"> ... </string>
-            				<string name="artist"> ... </string>
-            				<number name="duration"> ... </number>
-					<string name="audio"> ...url... </string>
-				</struct>
-			</array>
-            	</Params>
-	</Response>
-	

-
-
-
+	
<Response class="audio" function="getListAudio">
+      	<Params id="...">
+		<array name="audioList" quantity="..." ownerId="...">
+			<struct name="audio" id="...">
+				<string name="title"> ... </string>
+        			<string name="artist"> ... </string>
+        			<number name="duration"> ... </number>
+				<string name="audio"> ...url... </string>
+			</struct>
+		</array>
+        </Params>
+</Response>
+	

+	
+
+	
 	
Video

 	
getListVideo

 	Request:
-	
-	<Request class="video" function="getListVideo">
-      		<Params id="...">
-		</Params>
-        </Request>
+	
<Request class="video" function="getListVideo">
+      	<Params id="...">
+	</Params>
+</Request>
 	

 	Response:
-	
-	<Response class="video" function="getListVideo">
-      		<Params>
-			<array name="videoList" quantity="..." ownerId="...">
-				<struct name="video" id="...">
-					<string name="title"> ... </string>
-            				<string name="description"> ... </string>
-            				<number name="duration"> ... </number>
-					<img name="Img"> ...url... </img>
-					<string name="link"> ...url... </string>
-					<string name="url"> ...url to player... </string>
-				</struct>
-			</array>
-            	</Params>
-	</Response>
-	

-
-
-
+	
<Response class="video" function="getListVideo">
+      	<Params>
+		<array name="videoList" quantity="..." ownerId="...">
+			<struct name="video" id="...">
+				<string name="title"> ... </string>
+        			<string name="description"> ... </string>
+        			<number name="duration"> ... </number>
+				<img name="Img"> ...url... </img>
+				<string name="link"> ...url... </string>
+				<string name="url"> ...url to player... </string>
+			</struct>
+		</array>
+        </Params>
+</Response>
+	

+	
+
+	
 	
News

+	
 
+	
 	
Info and error messages

 	
Error message format

-	
-	<Response class="systemMessages" function = "errorMessage">              
-    		<Params>
-        		<string name="moduleName"> ... </string>
-        		<string name="code"> ... </string>
-        		<string name="text"> ... </string>
-        		<string name="comment"> ... </string>
-        		<string name="type">user/internal/service </string>
-    		</Params>
-	</Response>
+	
<Response class="systemMessages" function = "errorMessage">              
+    	<Params>
+        	<string name="moduleName"> ... </string>
+        	<string name="code"> ... </string>
+        	<string name="text"> ... </string>
+        	<string name="comment"> ... </string>
+        	<string name="type">user/internal/service </string>
+    	</Params>
+</Response>
 	

 
 	
Info message format

-	
-	<Response class="systemMessages" function = "infoMessage">              
-    		<Params>
-        		<string name="moduleName"> ... </string>
-    		</Params>
-	</Response>
+	
<Response class="systemMessages" function = "infoMessage">              
+    	<Params>
+        	<string name="moduleName"> ... </string>
+    	</Params>
+</Response>
 	

-
-
+	
       
       
     
-- 
1.7.9.5