smugmug.albums.getInfo

Returns the details for an Album.

Arguments

• SessionID - string.
• AlbumID - string.
• Password - string (optional).
• SitePassword - string (optional).
• AlbumKey - string.

Result

• struct Album
  • integer id
  • string Title
  • struct Category
    • string id
  • struct SubCategory
    • string id
  • string Description
  • string Keywords
  • boolean Geography (owner)
  • integer Position
  • struct Highlight (owner)
    • string id
  • integer ImageCount
  • string LastUpdated
  • boolean Header (owner, power & pro only)
  • boolean Clean (owner)
  • boolean EXIF (owner)
  • boolean Filenames (owner)
  • boolean SquareThumbs (owner)
  • struct Template (owner)
    • string 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, power & pro only)
  • boolean Watermarking (owner, pro only)
  • struct Watermark (owner, pro only)
    • string 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)
    • string id

Fault Codes

• 4 - "invalid user (message)"
• 18 - "invalid API key"

Sample Request

http://api.smugmug.com/hack/json/1.2.0/?method=smugmug.albums.getInfo
	&SessionID=<SESSION ID>
	&AlbumID=<ALBUM	ID>

Sample Responses

REST

Standard Response:
<rsp stat="ok">
  <method>smugmug.albums.getInfo</method>
  <Album id="1" Key="smgms" Position="2" ImageCount="43" Title="2007-01-01" Description="" Keywords="" Public="0" Password="" PasswordHint="" Printable="1" Filenames="0" Comments="1" External="1" Originals="0" EXIF="1" Share="1" SortMethod="DateTimeOriginal" SortDirection="0" LastUpdated="2008-01-05 07:43:37" FamilyEdit="0" FriendEdit="0" HideOwner="0" CanRank="1" Clean="0" Geography="1" SmugSearchable="1" WorldSearchable="1" X2Larges="1" X3Larges="1">
    <Highlight id="0" />
    <Category id="0" />
    <SubCategory id="0" />
    <Community id="0" />
  </Album>
</rsp>

JSON

PHP

XML-RPC