-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<td bgcolor="#E2E2D2" class="border" height="40"><table width="85%" border="0" cellspacing="0" cellpadding="0">
<tr align="center">
<td><a href="index.html" class="toplinks">About</a></td>
+ <td class="toplinks">|</td>
+ <td><a href="sreenshots.html" class="toplinks">Screenshots</a></td>
<td class="toplinks">|</td>
- <td><a href="api.html" class="toplinks">MySocials API</a></td>
+ <td><a href="api.html" class="toplinks">MySocials API</a></td>
<td class="toplinks">|</td>
<td><a href="privacy.html" class="toplinks">Privacy</a></td>
<td class="toplinks">|</td>
<p> MySocials driver is provided as a shared library (libmsa<service_name>.so). Structure <b>msa_module *d</b> includes information about the driver (name, identifier, pointers to driver functions). This structure is filled during initialization of the driver.
</p>
<h3>Driver interface</h3>
- <p>Driver interface is described in file interface.h and consists of 4 functions:
+ <p>Driver interface is described in file interface.h and consists of 4 functions:</p>
<ul>
<li><b>msa_module_init(struct msa_module* d)</b> — driver initialization;</li>
<li><b>msa_module_get_info(struct msa_module* d)</b> — getting information about driver;</li>
<li><b>msa_module->send(xmlDocPtr request, xmlDocPtr* response, const struct msa_module* info)</b> — request sending and response receiveing;</li>
<li><b>msa_module->shutdown(const struct msa_module*)</b> - driver shutdown.</li>
</ul>
-
<h3>Driver initialization and shutting down</h3>
- Driver initialization is performed by using <b>msa_module_init(struct msa_module* d)</b> function. Instance of structure which stores profile setting is created during initialization. Parameter d stores identifier of this instance.
- <br>
+ <p>Driver initialization is performed by using <b>msa_module_init(struct msa_module* d)</b> function. Instance of structure which stores profile setting is created during initialization. Parameter d stores identifier of this instance.
+ <br />
Function <b>msa_module->shutdown(const struct msa_module*)</b> is used during program termination.
-
+ </p>
<h3>Interaction with driver</h3>
-
+ <p>
Fuction <b>msa_module->send(xmlDocPtr request, xmlDocPtr* response, const struct msa_module* info)</b> is used to perform requests to the driver.
Parameter <i>request</i> is a request in XML format. Description of structure of sending and receiveing data is described <a>here</a>.
Parameter <i>response</i> contains driver response in XML format.
<h2>MySocials driver data structures</h2>
<p>Here you can see description of data structures which are used by MySocials driver. These structures are declared in <b>mysocials_driver.h</b> file which is available for other applications from mysocials-dev package.
-
+ </p>
<h3>Enumerations</h3>
<h4>Error codes</h4>
- <pre>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
-}
+ <pre class="c" style="font-family:monospace;"><span style="color: #000000; font-weight: bold;">enum</span> error_type <span style="color: #009900;">{</span>
+ FAILURE<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Function finished with error</span>
+ SUCCESS<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Function finished without error</span>
+ ERROR_ALLOCATION_OF_MEMORY<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Allocation of memory</span>
+ ERROR_NO_FUNCTION<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Defining function error</span>
+ ERROR_INITIALIZATION_ALREADY_PASSED<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Re-initialization error</span>
+ ERROR_IS_BUSY<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Module is busy</span>
+ ERROR_SEND_DATA<span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Data sending error</span>
+ ERROR_PARSE_DATA <span style="color: #666666; font-style: italic;">// Data parsing error</span>
+<span style="color: #009900;">}</span>
</pre>
<h3>Driver interface</h3>
<p>MySocials driver interface described in <b>msa_module</b> structure. Some of the fields of this stucture are filled before initialization by application (marked with **), the rest of it is filled during initialization.</p>
- <pre>
- 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.
+
+ <pre class="c" style="font-family:monospace;"><span style="color: #993333;">struct</span> msa_module <span style="color: #009900;">{</span>
+ gchar <span style="color: #339933;">*</span>id<span style="color: #339933;">;</span> <span style="color: #666666; font-style: italic;">// Identifier </span>
+ gchar <span style="color: #339933;">*</span>name<span style="color: #339933;">;</span> <span style="color: #666666; font-style: italic;">// External driver name</span>
+ gchar<span style="color: #339933;">*</span> driverName<span style="color: #339933;">;</span> <span style="color: #666666; font-style: italic;">// Driver name for system purposes (equals driver identifier)</span>
+ gchar <span style="color: #339933;">*</span>pic<span style="color: #339933;">;</span> <span style="color: #666666; font-style: italic;">// Icon coded in base64</span>
+ gchar <span style="color: #339933;">*</span>proxy<span style="color: #339933;">;</span> <span style="color: #666666; font-style: italic;">// **Proxy server address or NULL</span>
+ gint port<span style="color: #339933;">;</span> <span style="color: #666666; font-style: italic;">// **Proxy server port</span>
+
+ <span style="color: #808080; font-style: italic;">/* 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.
+ */</span>
+
+ error_type <span style="color: #009900;">(</span><span style="color: #339933;">*</span>send<span style="color: #009900;">)</span><span style="color: #009900;">(</span><span style="color: #993333;">char</span><span style="color: #339933;">*</span> xmlRequest<span style="color: #339933;">,</span> <span style="color: #993333;">char</span><span style="color: #339933;">**</span> xmlResponse<span style="color: #339933;">,</span> <span style="color: #993333;">struct</span> msa_module <span style="color: #339933;">*</span>info<span style="color: #009900;">)</span>
+
+ <span style="color: #808080; font-style: italic;">/* 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);
-}
-
+ */</span>
+
+ error_type <span style="color: #009900;">(</span><span style="color: #339933;">*</span>shutdown<span style="color: #009900;">)</span><span style="color: #009900;">(</span><span style="color: #993333;">struct</span> msa_module<span style="color: #339933;">*</span> info<span style="color: #009900;">)</span><span style="color: #339933;">;</span>
+<span style="color: #009900;">}</span>
</pre>
<h2>Format of XML requests and responses</h2>
<h3>Common format of driver request and response</h3>
<h4>Request format</h4>
- <pre>
- <Request class="" function="" noAuthorize="true">
- <Params>
-
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">""</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">""</span> <span style="color: #000066;">noAuthorize</span>=<span style="color: #ff0000;">"true"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
</ul>
<h4>Response format</h4>
- <pre>
- <Response class="" function="" authorized="true" upload="..." download="...">
- <Params>
-
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">""</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">""</span> <span style="color: #000066;">authorized</span>=<span style="color: #ff0000;">"true"</span> <span style="color: #000066;">upload</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">download</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>download</i> - number of bytes received from server</li>
</ul>
- <p>Following classes are supported:
+ <p>Following classes are supported:</p>
<ul>
<li><i>settings:</i> class for working with settings</li>
<li><i>profile:</i> class for receiving data about user's profile</li>
<li><i>video:</i> class for working with video files</li>
<li><i>news:</i> class for working with news</li>
</ul>
- </p>
-
+
+ <!-- Settings start -->
<h3>Settings</h3>
<h4>getSettings</h4>
<b>Request:</b>
- <pre>
- <Request class="settings" function="getSettings">
- <Params/>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"settings"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getSettings"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b>
- <pre>
- <Response class="settings" function="getSettings">
- <Params>
- <string name="mid"> ... </string>
- <string name="sid"> ... </string>
- <string name="secret"> ... </string>
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"settings"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getSettings"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"mid"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"sid"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"secret"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p>Content of <i>Params</i> tag depends on the driver. It is recommended to save content of <i>Params</i> tag and send it to setup function without any changes.</p>
<h4>setSettings</h4>
<b>Request:</b>
- <pre>
- <Request class="settings" function="setSettings">
- <Params>
- <string name="mid"> ... </string>
- <string name="sid"> ... </string>
- <string name="secret"> ... </string>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"settings"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"setSettings"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"mid"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"sid"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"secret"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p><i>Params</i> tag must contain data received from driver during <i>getSettings</i> request.</p>
<b>Response:</b> info message or error message.
<h4>getListMethods</h4>
<b>Request:</b>
- <pre>
- <Request class="settings" function="getListMethods">
- <Params/>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"settings"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListMethods"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b>
- <pre>
- <Response class="settings" function="getListMethods">
- <Params>
- <string function="..." class="..."> ... </string>
- <string function="..." class="..."> ... </string>
- ...
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"settings"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListMethods"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ ...
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>testConnection</h4>
<b>Request:</b>
- <pre>
- <Request class="settings" function="testConnection">
- <Params/>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"settings"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"testConnection"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b> info message or error message.
+ <!-- Settings finish -->
-
-
+ <!-- Profile start -->
<h3>Profile</h3>
<h4>getProfile</h4>
<b>Request:</b>
- <pre>
- <Request class="profile" function="getProfile">
- <Params id="...">
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"profile"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getProfile"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p>Attribute <i>id</i> is an id of user whose profile is needed to be received (optional, equals id of owner of current account by default).</p>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"profile"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getProfile"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"FirstName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"NickName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"LastName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Gender"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Birthday"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"MobilePhone"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"HomePhone"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><img</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Img"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></img<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"CityName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"CountryName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>getBaseProfile</h4>
<b>Request:</b>
- <pre>
- <Request class="profile" function="getBaseProfile">
- <Params id="...">
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"profile"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getBaseProfile"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+
</pre>
<p>Attribute <i>id</i> is an id of user whose profile is needed to be received (optional, equals id of owner of current account by default).</p>
<b>Response:</b>
- <pre>
- <Response class="profile" function="getBaseProfile">
- <Params id="...">
- <string name="FirstName"> ... </string>
- <string name="NickName"> ... </string>
- <string name="LastName"> ... </string>
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"profile"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getBaseProfile"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"FirstName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"NickName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"LastName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
+ <!-- Profile finish -->
-
-
+ <!-- Friends start -->
<h3>Friends</h3>
<h4>getListFriends</h4>
<b>Request:</b>
- <pre>
- <Request class="friends" function="getListFriends">
- <Params id="...">
- <number name="page"> ... </number>
- <number name="pageSize"> ... </number>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"friends"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListFriends"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
<li><i>id</i> - user id (optional, equals id of owner of current account by default) </li>
</ul>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"friends"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListFriends"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"contactList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"contact"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"FirstName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"NickName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"LastName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"FriendStatus"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><img</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Img"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></img<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>deleteFriend</h4>
<b>Request:</b>
- <pre>
- <Request class="friends" function ="deleteFriend">
- <Params id="..."/>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"friends"</span> function =<span style="color: #ff0000;">"deleteFriend"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b> info message or error message.
+ <!-- Friends finish -->
-
-
+ <!-- Photos start -->
<h3>Photos</h3>
<h4>createAlbum</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function="createAlbum">
- <Params id="...">
- <string name="name"> ... </string>
- <string name="description"> ... </string>
- <string name="privacy">PRIVACY</string>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"createAlbum"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"name"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"privacy"</span><span style="color: #000000; font-weight: bold;">></span></span>PRIVACY<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
PRIVACY can have following values:
<ul>
<li><i>description</i> - optional </li>
</ul>
<b>Response:</b>
- <pre>
- <Response class="photos" function="createAlbum">
- <Params id="...">
- <string name="albumId"> ... </string>
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"createAlbum"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>getListAlbums</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function="getListAlbums">
- <Params id="..."/>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListAlbums"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p><i>id</i> - optional, equals id of owner of current account by default.</p>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListAlbums"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumList"</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"album"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"thumbId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><img</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Img"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></img<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"created"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"updated"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"size"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"canUpload"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p><i>canUpload</i> - optional, if this parameter isn't set, it means that album is available for current user.</p>
<h4>uploadPhoto</h4>
<b>Request:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"uploadPhoto"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumPrivacy"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumDescription"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"file"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"fileName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"tags"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li>There have to be only one of parameters <i>albumName</i> or <i>albumId</i> in request.</li>
<li>Parameter <i>fileName</i> contains name of file for upload.</li>
</ul>
<b>Response:</b>
- <pre>
- <Response class="photos" function = "uploadPhoto">
- <Params>
- <string name="albumId"> ... </string>
- <string name="photoId"> ... </string>
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"uploadPhoto"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photoId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>getListPhotos</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function = "getListPhotos">
- <Params id="...">
- <string name="albumId"> ... </string>
- <number name="page"> ... </number>
- <number name="pageSize"> ... </number>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"getListPhotos"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
<li><i>id</i> - user id (optional, equals id of owner of current account by default) </li>
</ul>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListPhotos"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photosList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">albumId</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photo"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlSmall"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlBig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlOrig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"created"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>getListUserPhotos</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function = "getListUserPhotos">
- <Params id="...">
- <number name="page"> ... </number>
- <number name="pageSize"> ... </number>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"getListUserPhotos"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
<li><i>id</i> - user id (optional, equals id of owner of current account by default) </li>
</ul>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListUserPhotos"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photosList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photo"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"ownerId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlSmall"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlBig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlOrig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"created"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>getListPhotoTags</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function = "getListPhotoTags">
- <Params>
- <string name="ownerId"> ... </string>
- <string name="albumId"> ... </string>
- <string name="photoId"> ... </string>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"getListPhotoTags"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"ownerId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photoId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListPhotoTags"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"tagsList"</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">albumId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">photoId</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"tag"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"userId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"created"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
+
<p>Parameter <i>userId</i> is an id of user which is marked on photo (optional).</p>
<h4>getListFavoritePhotos</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function = "getListFavoritePhotos">
- <Params id="...">
- <number name="page"> ... </number>
- <number name="pageSize"> ... </number>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"getListFavoritePhotos"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
<li><i>id</i> - user id (optional, equals id of owner of current account by default) </li>
</ul>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListFavoritePhotos"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photosList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photo"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"ownerId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlSmall"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlBig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlOrig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"created"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>getPhoto</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function = "getPhoto">
- <Params>
- <string name="url"> ... </string>
- <string name="path"> ... </string>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"getPhoto"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"url"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"path"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b> info message or error message.
<h4>getListPhotoComments</h4>
<b>Request:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> function = <span style="color: #ff0000;">"getListPhotoComments"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"ownerId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photoId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
<li><i>pageSize</i> - page size (optional, positive integer, equals 100 by default)</li>
</ul>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListPhotoComments"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"commentsList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">albumId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">photoId</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"comment"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">/></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"ParentId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Time"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p>Parameter <i>ParentId</i> is an id of previous comment, if there is such one (optional).</p>
<h4>sendPhotoComment</h4>
<b>Request:</b>
- <pre>
- <Request class="photos" function="sendPhotoComment">
- <Params>
- <string name="ownerId"> ... </string>
- <string name="albumId"> ... </string>
- <string name="photoId"> ... </string>
- <string name="text"> ... </string>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"photos"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"sendPhotoComment"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"ownerId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"photoId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b> info message or error message.
-
-
+ <!-- Friends finish -->
+ <!-- Messages start -->
<h3>Messages</h3>
<h4>getListOutboxMessages</h4>
<b>Request:</b>
- <pre>
- <Request class="messages" function="getListOutboxMessages">
- <Params>
- <number name="page"> ... </number>
- <number name="pageSize"> ... </number>
- <number name="timeOffset"> ... </number>
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListOutboxMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"timeOffset"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<ul>
<li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
<li><i>timeOffset</i> - time offset for requested messages</li>
</ul>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getListOutboxMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"message"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"recipientList"</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"recipient"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"RecipientId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"RecipientName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Time"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Status"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ ...
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<p>Parameter <i>attachment</i> is optional, its content depends on attribute <i>type</i> and can have following values:</p>
- <pre>
- <attachment id="..." ownerId="..." type="image">
- <string name="name"> ... </string>
- <string name="albumId"> ... </string>
- <string name="urlSmall"> ... </string>
- <string name="urlBig"> ... </string>
- </attachment>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"image"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"name"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"albumId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlSmall"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlBig"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"video"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"name"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"url"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"duration"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlImage"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"audio"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"name"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"url"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"duration"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"link"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"name"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"url"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"urlImage"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"note"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"name"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"url"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+
+ <h4>getListInboxMessages</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListInboxMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"timeOffset"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <ul>
+ <li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
+ <li><i>pageSize</i> - page size (optional, positive integer, equals 100 by default)</li>
+ <li><i>timeOffset</i> - time offset for requested news (optional)</li>
+ </ul>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getListInboxMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"message"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Time"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Status"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ ...
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
- <attachment id="..." ownerId="..." type="video">
- <string name="name"> ... </string>
- <string name="url"> ... </string>
- <number name="duration"> ... </number>
- <string name="urlImage"> ... </string>
- </attachment>
+ <h4>getListThreads</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListThreads"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <ul>
+ <li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
+ <li><i>pageSize</i> - page size (optional, positive integer, equals 100 by default)</li>
+ </ul>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getListThreads"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"threadList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"thread"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"time"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"size"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
- <attachment id="..." ownerId="..." type="audio">
- <string name="name"> ... </string>
- <string name="url"> ... </string>
- <number name="duration"> ... </number>
- </attachment>
+ <h4>getListThreadMessages</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListThreadMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"threadId"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <ul>
+ <li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
+ <li><i>pageSize</i> - page size (optional, positive integer, equals 100 by default)</li>
+ </ul>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getListThreadMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageList"</span> <span style="color: #000066;">threadId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"message"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"recipientList"</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"recipient"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"RecipientId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"RecipientName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Time"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Status"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ ...
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <ul>
+ <li><i>time</i> - time of the last message in thread</li>
+ <li><i>senderId and senderName</i> - available only for inbox messages</li>
+ <li><i>recipientList</i> - available only for outbox messages</li>
+ </ul>
- <attachment id="..." ownerId="..." type="link">
- <string name="name"> ... </string>
- <string name="url"> ... </string>
- <string name="urlImage"> ... </string>
- </attachment>
+ <h4>getTotalCountInbox</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getTotalCountInbox"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getTotalCountInbox"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"quantity"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
- <attachment id="..." ownerId="..." type="note">
- <string name="name"> ... </string>
- <string name="url"> ... </string>
- </attachment>
+ <h4>getTotalCountOutbox</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getTotalCountOutbox"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span><span style="color: #000000; font-weight: bold;">/></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getTotalCountOutbox"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"quantity"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+
+ <h4>getCountInboxByTime</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getCountInboxByTime"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"timeOffset"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getCountInboxByTime"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"quantity"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+
+ <h4>getCountOutboxByTime</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getCountOutboxByTime"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"timeOffset"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getCountOutboxByTime"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"quantity"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+
+ <h4>sendMessage</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"sendMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b> info message or error message.
+
+ <h4>readMessage</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"> <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"readMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b> info message or error message.
+
+ <h4>deleteMessage</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"deleteMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b> info message or error message.
+ <h4>getListWallMessages</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListWallMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getListWallMessages"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"message"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderId"</span><span style="color: #000000; font-weight: bold;">></span></span>... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"SenderName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Time"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ ...
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <p>Content of the <i>attachment</i> tag is the same as in class <i>Messages</i>.</p>
+ <h4>getTotalCountWall</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getTotalCountWall"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"getTotalCountWall"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"quantity"</span><span style="color: #000000; font-weight: bold;">></span></span>123<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <h4>sendWallMessages</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> function = <span style="color: #ff0000;">"sendWallMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"text"</span><span style="color: #000000; font-weight: bold;">></span></span>text of message<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b> info message or error message.
+ <h4>deleteWallMessages</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"messages"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"deleteWallMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"messageId"</span><span style="color: #000000; font-weight: bold;">></span></span>...<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b> info message or error message.
+ <!-- Messages finish -->
+ <!-- Audio start -->
<h3>Audio</h3>
<h4>getListAudio</h4>
<b>Request:</b>
- <pre>
- <Request class="audio" function="getListAudio">
- <Params id="...">
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"audio"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListAudio"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"audio"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListAudio"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"audioList"</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"audio"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"artist"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"duration"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"audio"</span><span style="color: #000000; font-weight: bold;">></span></span> ...url... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
+ <h4>getAudio</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"audio"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getAudio"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"vk..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"audioId"</span><span style="color: #000000; font-weight: bold;">></span></span>...<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"audio"</span> function = <span style="color: #ff0000;">"getAudio"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"audio"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"vk..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"vk..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"title"</span><span style="color: #000000; font-weight: bold;">></span></span>...<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"artist"</span><span style="color: #000000; font-weight: bold;">></span></span>...<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"duration"</span><span style="color: #000000; font-weight: bold;">></span></span>...<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"audio"</span><span style="color: #000000; font-weight: bold;">></span></span>...url...<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <!-- Audio finish -->
-
+ <!-- Video start -->
<h3>Video</h3>
<h4>getListVideo</h4>
<b>Request:</b>
- <pre>
- <Request class="video" function="getListVideo">
- <Params id="...">
- </Params>
- </Request>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"video"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListVideo"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<b>Response:</b>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"video"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListVideo"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"videoList"</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"video"</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"title"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"description"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"duration"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><img</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"Img"</span><span style="color: #000000; font-weight: bold;">></span></span> ...url... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></img<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"link"</span><span style="color: #000000; font-weight: bold;">></span></span> ...url... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"url"</span><span style="color: #000000; font-weight: bold;">></span></span> ...url to player... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
+ <!-- Video finish -->
-
-
+ <!-- News start -->
<h3>News</h3>
+ <h4>getListNews</h4>
+ <b>Request:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"news"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListNews"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"page"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"pageSize"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"timeOffset"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"newsType"</span><span style="color: #000000; font-weight: bold;">></span></span>TYPE<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Request<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <ul>
+ <li><i>page</i> - number of page that is requested (optional, positive integer, equals 1 by default)</li>
+ <li><i>pageSize</i> - page size (optional, positive integer, equals 100 by default)</li>
+ <li><i>timeOffset</i> - time offset for requested news (optional)</li>
+ </ul>
+ <p>TYPE can have following values:</p>
+ <ul>
+ <li><i>photo:</i> new friends' photos</li>
+ <li><i>message:</i> new wall messages</li>
+ <li><i>comment:</i> new comments to user's photos and comments to friends' photos that were commented by the user</li>
+ <li><i>audio:</i> new friends' audio</li>
+ <li><i>video:</i> new friends' video</li>
+ <li><i>like:</i> new "Like" marks</li>
+ <li><i>tag:</i> new mark on photos</li>
+ <li><i>friend:</i> new friends' friends</li>
+ </ul>
+ <b>Response:</b>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"news"</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">"getListNews"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><array</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"newsList"</span> <span style="color: #000066;">page</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">pageSize</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">quantity</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">newsType</span>=<span style="color: #ff0000;">"TYPE"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><struct</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"news"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"authorId"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"authorName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><number</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"created"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></number<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><attachment</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">ownerId</span>=<span style="color: #ff0000;">"..."</span> <span style="color: #000066;">type</span>=<span style="color: #ff0000;">"image/video/audio/link/note"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></attachment<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></struct<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></array<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
+ </pre>
+ <i>authorName</i> - news author name (optional).
+ <p>Content of the <i>attachment</i> tag is the same as in class <i>Messages</i>.</p>
+ <!-- News finish -->
+ <!-- Info messages start -->
<h3>Info and error messages</h3>
<h4>Error message format</h4>
- <pre>
- <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>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"systemMessages"</span> function = <span style="color: #ff0000;">"errorMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"moduleName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"code"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"text"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"comment"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"type"</span><span style="color: #000000; font-weight: bold;">></span></span>user/internal/service <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
<h4>Info message format</h4>
- <pre>
- <Response class="systemMessages" function = "infoMessage">
- <Params>
- <string name="moduleName"> ... </string>
- </Params>
- </Response>
+ <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">"systemMessages"</span> function = <span style="color: #ff0000;">"infoMessage"</span><span style="color: #000000; font-weight: bold;">></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"><string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">"moduleName"</span><span style="color: #000000; font-weight: bold;">></span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></string<span style="color: #000000; font-weight: bold;">></span></span></span>
+ <span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Params<span style="color: #000000; font-weight: bold;">></span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;"></Response<span style="color: #000000; font-weight: bold;">></span></span></span>
</pre>
-
-
+ <!-- Info messages finish -->
</td>
</tr>
</table></td>
projects / mysocials / blobdiff