PmWiki | APIMethods / cc.cardsets.getList

Returns the flashcard sets belonging to the calling user.

Authentication

This method requires authentication with read permission.

Arguments

api_key (Required)

          Your API key. See here for more details.

Example Response

<cardsets>
     <set id="12f87d" title="Algebra" cards="34" folder_id="0" folder_title="" level_1="28" level_2="4" level_3="1" level_4="0" level_5="0" level_6="1" last_learned="0" size="81920" />
     <set id="1c345b76" title="Biology and Evolution" cards="65" folder_id="437c3b6" folder_title="Biology" level_1="3" level_2="2" level_3="0" level_4="0" level_5="30" level_6="30" last_learned="1354909501" size="5120" />
     <set id="a876543" title="Business Studies" cards="273" folder_id="0" folder_title="" level_1="260" level_2="0" level_3="0" level_4="10" level_5="0" level_6="3" last_learned="0" size="2411725" />
</cardsets>

Notice: title will be returned HTML encoded.
Notice: size will be returned as bytes.
Notice: (level)
1 = Not known
2 = Level 1
3 = Level 2
4 = Level 3
5 = Level 4
6 = Half known
Notice: last_learned is unix timestamp.

Error Codes

40: List is empty

          The requested list of sets for the specified user is empty.

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.