API.fetchAccountSubscriptions
This action allows you to recover all or part of the subscriptions of an 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. |
| account_id | integer | ID of the account you wish to recover the subscriptions from. If left blank, your account will be used. |
| order | string | String of characters used to define the organization criteria of the subscriptions (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 subscriptions. Default is 0. |
| step | integer | Number of subscriptions to be sent from the start position (max: 50). |
Response
This request sends an array of subscriptions.
Example responses
<response>
<requestid>...</requestid>
<requests>...</requests>
<status>ok</status>
<content>
<total>...</total>
<start>...</start>
<step>...</step>
<items>
<item>
<ID>...</ID>
<AccountID>...</AccountID>
<Name>...</Name>
<Description>...</Description>
<Books>...</Books>
<Subscribers>...</Subscribers>
<Creation>...</Creation>
<Modification>...</Modification>
<PublicUrl>...</PublicUrl>
</item>
</items>
</content>
</response>
{
"response": {
"requestid": ...,
"requests": ...,
"status": "ok",
"content": {
"total": ...,
"start": ...,
"step": ...,
"items": [
{
"ID": ...,
"AccountID": ...,
"Name": ...,
"Description": ...,
"Books": ...,
"Subscribers": ...,
"Creation": ...,
"Modification": ...,
"PublicUrl": ...
}
]
}
}
}
[
"response" => [
"requestid" => ...,
"requests" => ...,
"status" => "ok",
"content" => [
"total" => ...,
"start" => ...,
"step" => ...,
"items" => [
[
"ID" => ...,
"AccountID" => ...,
"Name" => ...,
"Description" => ...,
"Books" => ...,
"Subscribers" => ...,
"Creation" => ...,
"Modification" => ...,
"PublicUrl" => ...
]
]
]
]
]
Error codes
See the error code section.
