PmWiki | APIMethods / cc.cardsets.search

Returns the cards matching some criteria.

Authentication

This method requires authentication with read permission.

Arguments

api_key (Required)

          Your API key. See here for more details.

text (Required)

          The text to search for.

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" set_id="12bv54f" set_title="Examples" title="Capital" content="Berlin">
          <images />
     </card>
     <card id="9876c43" set_id="1c345b76" set_title="Math" title="2^2 + 2^2" content="8">
          <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.

Error Codes

50: Text is empty

          The text to search for is empty.

51: Search resulted in no hits

          The search did not match any content.

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.