ljr/livejournal/doc/raw/build/protocol/editfriendgroups.mode.xml

120 lines
3.6 KiB
XML
Raw Permalink Normal View History

2019-02-05 21:49:12 +00:00
<method name="editfriendgroups">
<shortdes>
Edit the user's defined groups of friends.
</shortdes>
<des>
Given several optional lists, will add/delete/update/rename the friends groups for a user.
</des>
<arguments><struct count="1">
&authInfo;
<key name="groupmasks" count="opt"><struct count="1">
<des>
A structure of friend userids. The values of each are a string representing an unsigned 32-bit integer with bit 0 set (or the server will force it on anyway), bits 1-30 set for each group the friend belongs to, and bit 31 unset (reserved for future use).
</des>
</struct></key>
<key name="set" count="opt"><struct count="1">
<des>
Given the bit of a friend group, the value contains a structure of information on it.
</des>
<struct count="0more">
<key name="name" count="1"><scalar><des>
Create or rename the friend group by sending this key. The value is the name of the group.
</des></scalar></key>
<key name="sort" count="opt"><scalar><des>
This field should be sent to indicate the sorting order of this group. The value must be in the range of 0-255. The default is 50.
</des></scalar></key>
<key name="public" count="opt"><scalar><des>
If this is "1", then this group is marked as public. If public, other users can see the name of the group and the people that are in it.
</des></scalar></key>
</struct>
</struct></key>
<key name="delete" count="opt"><list count="1"><scalar count="0more"><des>
A number of a friend group to delete (which can be from 1-30, inclusive). The server will modify all old entries that allow access to that friend group, so a new friend group using that number won't have access to old non-related entries, and unset the bit for that friend group on the groupmask of each friend, unless your client sends the friend's new groupmask explicitly.
</des></scalar></list></key>
</struct></arguments>
<expost>
POST /interface/xmlrpc HTTP/1.0
User-Agent: XMLRPC Client 1.0
Host: www.livejournal.com
Content-Type: text/xml
Content-Length: 780
&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;methodCall&gt;
&lt;methodName&gt;LJ.XMLRPC.editfriendgroups&lt;/methodName&gt;
&lt;params&gt;
&lt;param&gt;
&lt;value&gt;&lt;struct&gt;
&lt;member&gt;&lt;name&gt;username&lt;/name&gt;
&lt;value&gt;&lt;string&gt;test&lt;/string&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;member&gt;&lt;name&gt;password&lt;/name&gt;
&lt;value&gt;&lt;string&gt;test&lt;/string&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;member&gt;&lt;name&gt;ver&lt;/name&gt;
&lt;value&gt;&lt;int&gt;1&lt;/int&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;member&gt;&lt;name&gt;set&lt;/name&gt;
&lt;value&gt;&lt;struct&gt;
&lt;member&gt;&lt;name&gt;1&lt;/name&gt;
&lt;value&gt;&lt;struct&gt;
&lt;member&gt;&lt;name&gt;name&lt;/name&gt;
&lt;value&gt;&lt;string&gt;Good Friends&lt;/string&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;member&gt;&lt;name&gt;sort&lt;/name&gt;
&lt;value&gt;&lt;int&gt;25&lt;/int&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;member&gt;&lt;name&gt;public&lt;/name&gt;
&lt;value&gt;&lt;boolean&gt;1&lt;/boolean&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;/struct&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;/struct&gt;&lt;/value&gt;
&lt;/member&gt;
&lt;/struct&gt;&lt;/value&gt;
&lt;/param&gt;
&lt;/params&gt;
&lt;/methodCall&gt;
</expost>
<!--===================[ RETURN ]==============================-->
<returns><struct count="1">
</struct></returns>
<exreturn>
HTTP/1.1 200 OK
Connection: close
Content-length: 132
Content-Type: text/xml
Date: Mon, 15 Jul 2002 23:16:33 GMT
Server: Apache/1.3.4 (Unix)
&lt;?xml version="1.0"?&gt;
&lt;methodResponse&gt;
&lt;params&gt;
&lt;param&gt;
&lt;value&gt;&lt;struct&gt;
&lt;/struct&gt;&lt;/value&gt;
&lt;/param&gt;
&lt;/params&gt;
&lt;/methodResponse&gt;
</exreturn>
</method>