PmWiki | APIMethods / cc.cards.get

Returns a flashcard.

Authentication

This method requires authentication with read permission.

Arguments

api_key (Required)

          Your API key. See here for more details.

card_id (Required)

          The ID of the card to get.

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

<card id="9786c43" set_id="12bv54f" title="The capital of Germany" content="Berlin" tags="Geography,Cities"
      level="6" position="4" last_learned="1301312864" last_edited="0">
     <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>

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 card ID

          The specified card 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.