API.fetchAccountFavorites
This action allows you to recover all or part of the favourite publications of your account.
Request
The API key must have the commons access right.
| Name | Type | Description |
|---|---|---|
| apikey[required] | string | API public key |
| signature[required] | string | Signature of the request. See how to sign your requests. |
| expires | timestamp | UNIX timestamp for request expiration. |
| output | string | Format of the response. Either XML (default), JSON or PHP. |
| order | string | String of characters used to define the organization criteria of the publications (see sorting) |
| way | string | String of characters used to define the sort order. Either UP (default) or DOWN. |
| start | integer | Start position of the range of publications. Default is 0. |
| step | integer | Number of publications to be sent from the start position (max: 50). |
Response
This method returns an array of publications.
Example responses
<response>
<requestid>...</requestid>
<requests>...</requests>
<status>ok</status>
<content>
<total>...</total>
<start>...</start>
<step>...</step>
<items>
<item>
<ID>...</ID>
<AccountID>...</AccountID>
<SubscriptionID>...</SubscriptionID>
<Name>...</Name>
<Description>...</Description>
<Status>...</Status>
<IsPublished>...</IsPublished>
<IsPrivate>...</IsPrivate>
<AuthID>...</AuthID>
<AllowMini>...</AllowMini>
<Date>...</Date>
<Pages>...</Pages>
<Width>...</Width>
<Height>...</Height>
<Views>...</Views>
<Downloads>...</Downloads>
<Comments>...</Comments>
<Favorites>...</Favorites>
<Creation>...</Creation>
<Modification>...</Modification>
<PictureUrl>...</PictureUrl>
<ThumbUrl>...</ThumbUrl>
<PublicUrl>...</PublicUrl>
<ViewUrl>...</ViewUrl>
</item>
</items>
</content>
</response>
{
"response": {
"requestid": ...,
"requests": ...,
"status": "ok",
"content": {
"total": ...,
"start": ...,
"step": ...,
"items": [
{
"ID": ...,
"AccountID": ...,
"SubscriptionID": ...,
"Name": ...,
"Description": ...,
"Status": ...,
"IsPublished": ...,
"IsPrivate": ...,
"AuthID": ...,
"AllowMini": ...,
"Date": ...,
"Pages": ...,
"Width": ...,
"Height": ...,
"Views": ...,
"Downloads": ...,
"Comments": ...,
"Favorites": ...,
"Creation": ...,
"Modification": ...,
"PictureUrl": ...
"ThumbUrl": ...
"PublicUrl": ...
"ViewUrl": ...
}
]
}
}
}
[
"response" => [
"requestid" => ...,
"requests" => ...,
"status" => "ok",
"content" => [
"total" => ...,
"start" => ...,
"step" => ...,
"items" => [
[
"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 code section.
