PmWiki | APIMethods / cc.pool.getCards

Returns the cards for a public set.

Authentication

This method does not require authentication.

Arguments

api_key (Required)

          Your API key. See here for more details.

set_id (Required)

          The ID of the set to get cards from.

Example Response

<cards>
     <card id="12d45f7" title="The capital of Germany" content="Berlin">
          <images />
     </card>
     <card id="9876c43" title="2^2 + 2^2" content="8">
          <images>
               <image path="relative/path/to/image" url="http/url/to/image" />
               <image path="relative/path/to/image" url="http/url/to/image" />
               <image path="relative/path/to/image" url="http/url/to/image" />
          </images>
     </card>
</cards>

Notice: title and content will be returned HTML encoded.

Error Codes

1: Invalid set ID

          The specified set ID was not valid.

2: Set is not freely accessible

          The specified set is commercial.

41: Set has no cards

          The specified set contains no cards.

100: Invalid API Key

          The API key passed 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.