PmWiki | APIMethods / cc.folders.get

Returns a folder.

Authentication

This method requires authentication with read permission.

Arguments

api_key (Required)

          Your API key. See here for more details.

folder_id (Required)

          The ID of the folder to get.

with_sets (Optional)

          Load all sets inside this folder.
          Valid values: {0, 1}.

Example Response

<id>12f87d</id>
<title>Mathematics</title>
<sets>2</sets>

Example Response with sets included

<folder id="12f87d" sets="2" title="Mathematics">
     <cardsets>
          <set cards="5" id="5s0l61212" last_learned="1354909501" level_1="1" level_2="0" level_3="0" level_4="0" level_5="0" level_6="4" title="Algebra" />
          <set cards="1" id="13tu31212" last_learned="0" level_1="0" level_2="1" level_3="0" level_4="0" level_5="0" level_6="0" title="Multiplication" />
     </cardsets>
</folder>

Error Codes

1: Invalid folder ID

          The specified folder ID was not valid.

98: Login failed / Invalid auth token

          The auth token passed were invalid or expired.

99: Insufficient permissions

          The authenticated method call did not have the required permissions.

100: Invalid API Key

          The API key passed was not valid.

101: Invalid signature

          The signature is missing or was not valid.

110: Format "xxx" not found

          The requested response format was not found.

120: Method "xxx" not found

          The requested method was not found.

130: HTTPS required

          The API Key passed requires HTTPS.