PmWiki | APIMethods / cc.cardsets.getCards

Returns the cards for a set.

Authentication

This method requires authentication with read permission.

Arguments

api_key (Required)

          Your API key. See here for more details.

set_id (Required)

          The ID of the set to get cards from.

filter (Optional)

          The filter to select specific cards. By default 'all'. Combine multiple values with comma.
Valid values: {all, leitner, level1, level2, level3, level4, level5, level6, tag:name_of_tag}.
img_src_urls (Optional)

          Set for the images full URLs instead of relative paths.
          The <images> section will then be dropped.
          Valid values: {0, 1}.

Example Response

<cards>
     <card id="12d45f7" title="Capital" content="Berlin" tags="Geography,Cities" level="1" position="1" last_learned="1300744282" last_edited="0">
          <images />
     </card>
     <card id="9876c43" title="2^2 + 2^2" content="8" tags="" level="6" position="2" last_learned="0" last_edited="1313074646">
          <images>
               <image path="relative/path/to/image" url="http/url/to/image" alt="[Pic1]" />
               <image path="relative/path/to/image" url="http/url/to/image" alt="[Pic2]" />
               <image path="relative/path/to/image" url="http/url/to/image" alt="[Pic3]" />
          </images>
     </card>
</cards>

Notice: title and content will be returned HTML encoded.
Notice: (level)
1 = Not known
2 = Level 1
3 = Level 2
4 = Level 3
5 = Level 4
6 = Half known
Notice: last_learned and last_edited are unix timestamps.

Error Codes

1: Invalid set ID

          The specified set ID was not valid.

41: Set has no cards

          The specified set contains no cards / no cards for this filter.

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.