API.renewBookPrivateUrl - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

API.renewBookPrivateUrl

From Calaméo Knowledge Base

This action allows you to renew a publication's private URL using its unique code.

<toc>

Request

The API key must have the publish access right.
Name Required Type Description
apikey yes string API public key
signature yes string Signature of the request. See How To Sign Your Requests.
expires yes timestamp UNIX timestamp for request expiration (GMT).
output string Format of the response. Either XML (default), JSON or PHP.
book_id yes string Unique identifying key of the publication.

Response

Return a Publication with the new private URL.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      ID: ...,
      AccountID: ...,
      SubscriptionID: ...,
      Name: ...,
      Description: ...,
      Status: ...,
      IsPublished: ...,
      IsPrivate: ...,
      AuthID: ...,
      AllowMini: ...,
      Date: ...,
      Pages: ...,
      Width: ...,
      Height: ...,
      Views: ...,
      Downloads: ...,
      Comments: ...,
      Favorites: ...,
      Creation: ...,
      Modification: ...,
      PictureUrl: ...
      ThumbUrl: ...
      PublicUrl: ...
      ViewUrl: ...
    }
  }
}

Error codes

See the Error Codes.