smugmug.users.getTree

Retrieves a tree of the album structure for a given user.

Arguments

• string SessionID
• string NickName (optional)
• boolean Heavy (optional)
• string SitePassword (optional)

Result

    standard response

• array Categories
  • struct Category
    • integer id
    • string Name
    • array SubCategories
      • struct SubCategory
        • integer id
        • string Name
        • array Albums
          • struct Album
            • integer id
            • string Key
            • string Title
    • array Albums
      • struct Album
        • integer id
        • string Key
        • string Title

    heavy response

• array Categories
  • struct Category
    • integer id
    • string Name
    • array SubCategories
      • struct SubCategory
        • integer id
        • string Name
        • array Albums
          • struct Album
    • array Albums
      • struct Album
        • integer id
        • string Key
        • string Title
        • struct Category
          • integer id
        • string Name
        • struct SubCategory
          • integer id
          • string Name
        • string Description
        • string Keywords
        • boolean Geography (owner)
        • integer Position
        • struct Hightlight (owner)
          • integer id
        • integer ImageCount
        • string LastUpdated
        • boolean Header (owner, power & pro only)
        • boolean Clean (owner)
        • boolean EXIF (owner)
        • boolean Filenames (owner)
        • struct Template (owner, power & pro only)
          • integer id
        • string SortMethod (owner)
        • boolean SortDirection (owner)
        • string Password (owner)
        • string PasswordHint (owner)
        • boolean Public (owner)
        • boolean WorldSearchable (owner)
        • boolean SmugSearchable (owner)
        • boolean External (owner)
        • boolean Protected (owner, pro only)
        • boolean Watermarking (owner, pro only)
        • struct Watermark (owner, pro only)
          • integer id
        • boolean HideOwner (owner)
        • boolean Larges (owner, pro only)
        • boolean XLarges (owner, pro only)
        • boolean X2Larges (owner)
        • boolean X3Larges (owner)
        • boolean Originals (owner)
        • boolean CanRank (owner)
        • boolean FriendEdit (owner)
        • boolean FamilyEdit (owner)
        • boolean Comments (owner)
        • boolean Share (owner)
        • boolean Printable (owner)
        • boolean DefaultColor (owner, pro only)
        • integer ProofDays (owner, pro only)
        • string Backprinting (owner, pro only)
        • float UnsharpAmount (owner, power & pro only)
        • float UnsharpRadius (owner, power & pro only)
        • float UnsharpThreshold (owner, power & pro only)
        • float UnsharpSigma (owner, power & pro only)
        • struct Community (owner)
          • integer id

Fault Codes

• 4 - "invalid user (message)"
• 5 - "system error"

Sample Responses

REST

JSON

PHP

XML-RPC