English Français Español
ex. : internet calameo download

API.fetchAccountFavorites

This action allows you to recover all or part of the favourite publications of your account.

Request

api_key
Use your API key
login
Use the e-mail address of an account profile that has access to the APIs.
md5_pwd
Use the password from the profile, encrypted in MD5 format.
order (optional)
String of characters used to define the organization criteria of the publications. The possible values are:
  • Name: Title of the publication
  • Pages: Number of pages of the publication
  • Comments: Number of comments on the publication
  • Views: Number of times the publication was read
  • Date: Date of publication
  • Creation: Date of creation
  • Modification: Date the publication was modified
way (optional)
String of characters used to define the sort order. The possible values are:
  • UP: Sort by ascending order
  • DOWN: Sort by descending order
start (optional)
Start position of the range of publications sent.
step (optional)
Number of publications to be sent from the start position.

Response

This request sends a table containing the requested publications with the following information:

Code
Unique identifying key for the publication.
Name
Title of the publication.
Description
Description of the publication.
IsPrivate
Sends 1 if the publication is private and 0 if not.
AllowMini
Sends 1 if the publication allows access to the miniViewer and 0 if not.
Pages
Number of pages of the publication.
Width
Width of a page of the publication.
Height
Height of a page of the publication.
Date
Date of citation of the publication.
Creation
Date of creation of the publication.
Modification
Date of the last modification of the publication.
PictureUrl
Absolute URL for the publication’s cover.
ThumbUrl
Absolute URL for the publication’s thumbnail.
PublicUrl
Absolute URL for the publication’s overview.
ViewUrl
Absolute URL for the publication’s reading page.
CommentsUrl
Absolute URL for the publication’s comments.

 

An error message is sent back in case of problems.

Example

This example shows how to recover the most recent of your 10 favorite publications:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The most recent of my 10 favourite publications</title>
</head>
<body>
<?php
    include_once('nusoap.php');
   
    $client = new soapclient('http://api.calameo.com/?wsdl', true);
    $err = $client->getError();
 
    if ($err) {
       // Display the errors
       echo 'SOAP Error: ' . $err;
       // If an error occurs, it\’s useless to continue
       die('An error has occurred!');
    }
    $message = 'API.fetchAccountFavorites';
    $params = array (
      'api_key'  => '123346544abdefbca1546854',
      'login'  => 'email@myaccount.com',
      'md5_pwd'  => 'd4f7ccab36fbfedc5f53e09d20d6973a',
      'order'  => 'Creation',
      'way'  => 'DOWN',
      'start'  => 0,
      'step'  => 10
      );
    $result = $client->call($message, $params);
    if ($client->fault) {
        // An error has occurred
        die('An error has occurred!');
    } else {
        // Verify if a SOAP error wasn’t sent back
        $err = $client->getError();
        if ($err) {
            // Display the error
     echo 'SOAP Error: ' . $err ;
        } else {
     // All went well, you can process the result => $result
            echo '<ol>';
            foreach ( $result as $book ) {
                echo '<li>';
                echo '<a href="' . $book['PublicUrl'] . '">';
                echo $book['Name'];
                echo '</a>';
                echo '</li>';
            }
            echo '</ol>';
        }
    }
?>
</body>
</html>