API 1.3.0

smugmug.albums.getInfo

Retrieve the information for an album.

Arguments

  • APIKey string (required)
    Your SmugMug API Key.

  • SessionID string
    A valid session.

  • AlbumID integer (required)
    The id for a specific album.

  • AlbumKey string (required)
    The key for a specific album.

  • Callback string (JSON & PHP responses only)
    A JSONP callback function to be executed on the client side.

  • Password string
    The password for the album.

  • Pretty boolean
    Return a more human friendly response.
    Default: false

  • Sandboxed boolean
    Forces URLs to a location with a crossdomain.xml file.
    Default: false

  • SitePassword string
    The site password for a specific user.

  • Strict boolean
    Enable strict error handling.
    Default: false

Response

  • Album struct
    • id integer
      The id for this album.

    • Key string
      The key for this album.

    • Backprinting string (owner, portfolio& pro accounts only)
      The text to be printed on the back of prints purchased from this album.

    • BoutiquePackaging integer (owner, pro accounts only)
      Enable boutique packaging for orders from this album.
        Values:
      • 0 - No
      • 1 - Yes
      • 2 - Inherit
    • CanRank boolean
      Allow images from this album to be ranked using PhotoRank.

    • Category struct
      The category that this album belongs to.
      • id integer
        The id for this category.

      • Name string
        The name for this category.

    • Clean boolean (owner)
      Hide the Description and LastUpdated for this album on the homepage and category pages.

    • ColorCorrection integer (owner)
      The color correction setting for this album.
        Values:
      • 0 - No
      • 1 - Yes
      • 2 - Inherit
    • Comments boolean
      Allow visitors to leave comments on this album.

    • Community struct (owner)
      The community that this album belongs to.
      • id integer
        The id for this community.

      • Name string
        The name for this community.

    • Description string
      The description for this album.

    • EXIF boolean
      Allow EXIF data to be viewed for images from this album.

    • External boolean
      Allow images from this album to be linked externally outside SmugMug.

    • FamilyEdit boolean (owner)
      Allow family to edit the captions and keywords of the images in this album.

    • Filenames boolean (owner)
      Show filename for images uploaded with no caption to this album.

    • FriendEdit boolean (owner)
      Allow friends to edit the captions and keywords of the images in this album.

    • Geography boolean
      Enable mapping features for this album.

    • GuestUploadURL string (owner)
      The URL to allow guests to upload to this gallery.

    • Header boolean (owner, power& portfolio& pro accounts only)
      Default this album to the standard SmugMug appearance.
        Values:
      • false - Custom
      • true - SmugMug
    • HideOwner boolean (owner)
      Hide the owner of this album.

    • Highlight struct
      The highlight image for this album.
      • id integer
        The id for this image.

      • Key string
        The key for this image.

      • Type string
        The type for this highlight image.
          Values:
        • Featured
        • Random
    • ImageCount integer
      The number of images in this album.

    • InterceptShipping integer (owner, pro accounts only)
      Enable intercept shipping (personal delivery) for orders from this album.
        Values:
      • 0 - No
      • 1 - Yes
      • 2 - Inherit
    • Keywords string
      The meta keyword string for this album.

    • Larges boolean (owner, portfolio& pro accounts only)
      Allow viewing of Large images for this album.

    • LastUpdated string
      The date that this album was last updated.

    • NiceName string (owner)
      The nicename for this album.

    • Originals boolean
      Allow viewing of Original images for this album.

    • PackagingBranding boolean (owner, pro accounts only)
      Enable packaging branding for orders from this album.

    • Password string (owner)
      The password for this album.

    • PasswordHint string
      The password hint for this album.

    • Passworded boolean
      Indicates whether this album is password protected.

    • Position integer
      The position of this album within the site.

    • Printable boolean
      Allow images from this album to purchased as a print, merchandise or digital download.

    • Printmark struct (owner, portfolio& pro accounts only)
      The printmark applied to images of this album.
      • id integer
        The id for this printmark.

      • Name string
        The name for this printmark.

    • ProofDays integer (owner, portfolio& pro accounts only)
      The number of days an order is held for a pro to proof prior to being sent to print.

    • Protected boolean (power& portfolio& pro accounts only)
      Enable right-click protection for this album.

    • Public boolean
      Display this album publicly.

    • Share boolean
      Display the Share button for this album.

    • SmugSearchable boolean (owner)
      Allow SmugMug to index images from this album.

    • SortDirection boolean (owner)
      The direction used for sorting images within this album.
        Values:
      • false - Ascending (1-99, A-Z, 1980-2004, etc)
      • true - Descending (99-1, Z-A, 2004-1980, etc)
    • SortMethod string (owner)
      The method used for sorting images within this album.
        Values:
      • Position - None
      • Caption - By caption
      • FileName - By filenames
      • Date - By date uploaded
      • DateTime - By date modified (if available)
      • DateTimeOriginal - By date taken (if available)
    • SquareThumbs boolean (owner)
      Enable automatic square cropping of thumbnails for this album.

    • SubCategory struct
      The subcategory that this album belongs to.
      • id integer
        The id for this subcategory.

      • Name string
        The name for this subcategory.

    • Template struct (owner)
      The style template applied to this album.
      • id integer
        The id of this style template.
          Values:
        • 0 - Viewer Choice
        • 3 - SmugMug
        • 4 - Traditional
        • 7 - All Thumbs
        • 8 - Slideshow
        • 9 - Journal (Old)
        • 10 - SmugMug Small
        • 11 - Filmstrip
        • 12 - Critique
        • 16 - Journal
        • 17 - Thumbnails
    • Theme struct (owner)
      The theme applied to this album.
      • id integer
        The id for this theme.

      • Name string
        The name for this theme.

      • Type string
        The type for this theme.
          Values:
        • SmugMug
        • User
    • Title string
      The title for this album.

    • URL string
      The URL for this album.

    • UnsharpAmount float (owner, power& portfolio& pro accounts only)
      The Amount setting used for sharpening display copies of images in this album.

    • UnsharpRadius float (owner, power& portfolio& pro accounts only)
      The Radius setting used for sharpening display copies of images in this album.

    • UnsharpSigma float (owner, power& portfolio& pro accounts only)
      The Sigma setting used for sharpening display copies of images in this album.

    • UnsharpThreshold float (owner, power& portfolio& pro accounts only)
      The Threshold setting used for sharpening display copies of images in this album.

    • UploadKey string (owner)
      The key to allow guest uploading to this album.

    • Watermark struct (owner, portfolio& pro accounts only)
      The watermark applied to images of this album.
      • id integer
        The id for this watermark.

      • Name string
        The name for this watermark.

    • Watermarking boolean (owner, portfolio& pro accounts only)
      Enable automatic watermarking of images for this album.

    • WorldSearchable boolean (owner)
      Allow search engines to index images from this album.

    • X2Larges boolean
      Allow viewing of X2Large images for this album.

    • X3Larges boolean
      Allow viewing of X3Large images for this album.

    • XLarges boolean (portfolio& pro accounts only)
      Allow viewing of XLarge images for this album.

Errors

  • 3 - invalid session
  • 4 - invalid user (message)
  • 16 - invalid data (message)
  • 18 - invalid API key
  • 22 - missing required parameter (message)
  • 98 - service unavailable

Sample Responses

{
    "stat": "ok",
    "method": "smugmug.albums.getInfo",
    "Album": {
        "id": 1234,
        "Key": "xCXXu",
        "Backprinting": "",
        "CanRank": true,
        "Category": {
            "id": 0,
            "Name": "Other"
        },
        "Clean": false,
        "ColorCorrection": 0,
        "Comments": true,
        "Description": "Photos from my party.",
        "EXIF": true,
        "External": false,
        "FamilyEdit": true,
        "FriendEdit": true,
        "Geography": false,
        "Header": true,
        "HideOwner": false,
        "ImageCount": 20,
        "Larges": true,
        "LastUpdated": "",
        "NiceName": "My-Birthday-2008",
        "Originals": false,
        "Password": "1973",
        "PasswordHint": "What year was I born ?",
        "Position": 1,
        "Printable": true,
        "ProofDays": 1,
        "Protected": false,
        "Public": false,
        "Share": true,
        "SmugSearchable": true,
        "SortDirection": false,
        "SortMethod": "DateTimeOriginal",
        "SquareThumbs": true,
        "Template": {
            "id": 0
        },
        "Title": "My Birthday 2008",
        "Type": "Album",
        "URL": "http://fred.smugmug.com/Other/My-Birthday-2008/1234_xCXXu",
        "UnsharpAmount": 0.2,
        "UnsharpRadius": 1,
        "UnsharpSigma": 1,
        "UnsharpThreshold": 0.05,
        "UploadKey": "",
        "Watermark": {
            "id": 0,
            "Name": "SmugMug"
        },
        "Watermarking": false,
        "WorldSearchable": true,
        "XLarges": true,
        "X2Larges": true,
        "X3Larges": true
    }
}