Dashboard > SmugMug > ... > API 1.2.0 > smugmug.subcategories 1.2.0 > smugmug.subcategories.getAll 1.2.0
Log In   View a printable version of the current page.
SmugMug
smugmug.subcategories.getAll 1.2.0
Added by David Parry , last edited by David Parry on Jan 03, 2008  (view change)
Labels: 
(None)

smugmug.subcategories.getAll

Retrieves a list of all subcategories for a given user.

Arguments

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

Result

  • array SubCategories
    • struct SubCategory
      • string id
      • string Title
      • struct Category
        • integer id


Note: From API version 1.2.1 onwards to resolve naming inconsistencies, the "Title" parameter has been renamed to "Name".

Fault Codes

  • 3 - "invalid session"
  • 4 - "invalid user"
  • 15 - "empty set - no subcategories found"

Sample Responses

REST

<rsp stat="ok">
  <method>smugmug.subcategories.getAll</method>
  <SubCategories>
    <SubCategory id="227" Title="2005 Photos"/>
      <Category id="59">
    <SubCategory id="500" Title="2006 Photos"/>
      <Category id="59">
    <SubCategory id="843" Title="2007 Photos"/>
      <Category id="59">
  </SubCategories>
</rsp>

JSON

{
  "stat":"ok",
  "method":"smugmug.subcategories.getAll",
  "Categories":[
    {"id":227,"Title":"2005 Photos","Category":{"id":59}},
    {"id":500,"Title":"2006 Photos","Category":{"id":59}},
    {"id":843,"Title":"2007 Photos","Category":{"id":59}},
  ]
}

PHP

a:3:{
  s:4:"stat";s:2:"ok";
  s:6:"method";s:25:"smugmug.subcategories.getAll";
  s:10:"Categories";a:3:{
    i:0;a:2:{s:2:"id";i:227;s:5:"Title";s:11:"2005 Photos";s:8:"Category";a:1:{s:2:"id";i:59;}}
    i:1;a:2:{s:2:"id";i:500;s:5:"Title";s:11:"2006 Photos";s:8:"Category";a:1:{s:2:"id";i:59;}}
    i:2;a:2:{s:2:"id";i:843;s:5:"Title";s:11:"2007 Photos";s:8:"Category";a:1:{s:2:"id";i:59;}}
  }
}

XML-RPC


Powered by Atlassian Confluence 2.7.1, the Enterprise Wiki. Bug/feature request - Atlassian news - Contact administrators