getusertags

getusertags — Retrieves a list of the user's defined tags.

Mode Description

Retrieves a list of the user's defined tags.

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.

    • usejournal(optional): Specify this key to get tags for another account that you have access to. By default, gets tags for your account.

      • [scalar](required) Journal username that authenticating user has 'usejournal' access in, as given in the 'login' mode.

Example 25. Sample call to LJ.XMLRPC.getusertags

FIXME: add example


Return Values

  1. [struct](required)

    Containing keys:

    • tags(required):

      • [array](required) A list of structs for all of the returned tags. Containing items:

        • [struct](optional; multiple allowed)

          Containing keys:

          • name(required):

            • [scalar](required) The name of the tag being returned.

          • security_level(required):

            • [scalar](required) The security (visibility) of the tag being returned. This can be one of 'public', 'private', 'friends', or 'group'. Note that 'group' doesn't provide any information about which groups, but that can be inferred from the security breakdown elsewhere in the structure.

          • uses(optional):

            • [scalar](required) If the tag has been used, returns the number of times it's been used overall.

          • display(optional):

            • [scalar](required) If present and on, indicates that this tag is visible to the S2 style system. Tags with this value set to off are still usable, they're just not exposed to S2.

          • security(optional): Shows the breakdown of use by security category.

            • [struct](optional; multiple allowed)

              Containing keys:

              • public(optional):

                • [scalar](required) The number of times this tag has been used on a public post.

              • private(optional):

                • [scalar](required) The number of times this tag has been used on a private post.

              • friends(optional):

                • [scalar](required) The number of times this tag has been used on a Friends-only post.

              • groups(optional):

                • [struct](optional; multiple allowed) Entries in the groups structure have the key being the id of the group (id as shown in getfriendgroups mode) and the value being the number of times this tag has appeared on an entry secured to that group.

                  Containing keys:

    Example 26. Sample return value for LJ.XMLRPC.getusertags

    FIXME: add example