Welcome, guest ( Login )

Powered by JotSpot

WikiHome » 1.2.0 » smugmug.albums.getInfo

smugmug.albums.getInfo

Version 9, changed by rkalla@gmail.com. 12/01/2007.   Show version history

API Method: smugmug.albums.getInfo

This method returns detailed information about the album specified by AlbumID. If the album isn't owned by the Session holder and also isn't public or has a password, an "invalid user" error will be returned. Note that many of the fields are protected for the owner's eyes only. Reduced information is provided to a non-owner.

Arguments:
  • String SessionID
  • int AlbumID
  • String Password optional
  • String SitePassword optional

Result:
  • struct
    • int "AlbumID"
    • int "HighlightID"
    • int "CategoryID"
    • int "SubCategoryID"
    • int "Position"
    • String "SortMethod"
      • Owner only
    • boolean "SortDirection"
      • Owner only
    • int "ImageCount"
    • String "Title"
    • String "Description"
    • String "Keywords"
    • String "LastUpdated"
    • int "CommunityID"
      • Owner only
    • boolean "Public"
      • Owner only
    • String "Password"
      • Owner only
    • boolean "Printable"
      • Owner only
    • boolean "Filenames"
      • Owner only
    • boolean "Comments"
      • Owner only
    • boolean "External"
      • Owner only
    • boolean "Originals"
      • Owner only
    • boolean "FamilyEdit"
      • Owner only
    • boolean "FriendEdit"
      • Owner only
    • boolean "HideOwner"
      • Owner only
    • boolean "EXIF"
      • Owner only
    • boolean "Share"
      • Owner only
    • boolean "Header"
      • Owner only
      • Power+Pro only!
    • int "TemplateID"
      • Owner only
      • Power+Pro only!
    • boolean "Larges"
      • Owner only
      • Pro only!
    • boolean "XLarges"
      • Owner only
      • Pro only!
    • boolean "X2Larges"
      • Owner only
    • boolean "X3Larges"
      • Owner only
    • boolean "DefaultColor"
      • Owner only
      • Pro only!
    • boolean "Clean"
      • Owner only
    • boolean "Protected"
      • Owner only
      • Pro only!
    • boolean "Watermarking"
      • Owner only
      • Pro only!
    • int "WatermarkID"
      • Owner only
      • Pro only!
    • boolean "SmugSearchable"
      • Owner only
    • float "UnsharpAmount"
      • Owner only
      • Power+Pro only!
    • float "UnsharpRadius"
      • Owner only
      • Power+Pro only!
    • float "UnsharpThreshold"
      • Owner only
      • Power+Pro only!
    • float "UnsharpSIgma"
      • Owner only
      • Power+Pro only!
    • boolean "WorldSearchable"
      • Owner only


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

Attachments (0)

  File By Size Attached Ver.