getfriendgroups

getfriendgroups — Retrieves a list of the user's defined groups of friends.

Mode Description

Retrieves a list of the user's defined groups of friends.

Arguments

  1. [struct](required)

    Containing keys:

    • username(required):

      • [scalar](required) Username of user logging in.

    • auth_method(optional):

      • [scalar](required) Authentication method used for this request. The default value is "clear", for plain-text authentication. "cookie" and any of the challenge-response methods are also acceptable.

    • password(optional):

      • [scalar](required) Deprecated. Password of user logging in in plaintext. If using the "clear" authentication method, either this or "hpassword" must be present.

    • hpassword(optional):

      • [scalar](required) Deprecated. MD5 digest of user's password. Not much more secure than password, but at least it's not in plain text.

    • auth_challenge(optional):

      • [scalar](required) If using challenge-response authentication, this should be the challenge that was issued to you by the server.

    • auth_response(optional):

      • [scalar](required) If using challenge-response authentication, this should be the response hash that you generate, based on the formula required for your challenge.

    • ver(optional):

      • [scalar](required) Protocol version supported by the client; assumed to be 0 if not specified. See Chapter 27, Protocol Versions for details on the protocol version.

Example 23. Sample call to LJ.XMLRPC.getfriendgroups

POST /interface/xmlrpc HTTP/1.0
User-Agent: XMLRPC Client 1.0
Host: www.livejournal.com
Content-Type: text/xml
Content-Length: 406

<?xml version="1.0"?>
<methodCall>
<methodName>LJ.XMLRPC.getfriendgroups</methodName>
<params>
<param>

<value><struct>
<member><name>username</name>
<value><string>test</string></value>
</member>
<member><name>password</name>

<value><string>test</string></value>
</member>
<member><name>ver</name>
<value><int>1</int></value>

</member>
</struct></value>
</param>
</params>
</methodCall>


Return Values

  1. [struct](required)

    Containing keys:

    • friendgroups(required):

      • [array](required) Containing items:

        • [struct](optional; multiple allowed)

          Containing keys:

          • id(required):

            • [scalar](required) The bit number for this friend group, from 1-30.

          • name(required):

            • [scalar](required) The name of this friend group.

          • sortorder(required):

            • [scalar](required) The sort integer for this friend group, from 0-255.

          • public(required):

            • [scalar](required) Either '0' or '1' for if this friend group is public.

Example 24. Sample return value for LJ.XMLRPC.getfriendgroups

HTTP/1.1 200 OK
Connection: close
Content-length: 536
Content-Type: text/xml
Date: Tue, 16 Jul 2002 01:03:10 GMT
Server: Apache/1.3.4 (Unix)

<?xml version="1.0"?>

<methodResponse>
<params>
<param>
<value><struct>
<member><name>friendgroups</name>
<value><array>

<data>
<value><struct>
<member><name>sortorder</name>
<value><int>25</int></value>
</member>

<member><name>id</name>
<value><int>1</int></value>
</member>
<member><name>public</name>

<value><int>1</int></value>
</member>
<member><name>name</name>
<value><string>Good Friends</string></value>

</member>
</struct></value>
</data>
</array></value>
</member>
</struct></value>
</param>

</params>
</methodResponse>