Collection List representation
This article describes the JSON format that represents a list of collections in the FotoWeb RESTfull API. This is the application/vnd.fotoware.collectionlist+json media type.
Usage
Representation of ...
MIME type:
Accept: application/vnd.fotoware.collectionlist+json
Resource(s): The archive list, the album list and photo streams and folders of archives and search results in archives have this representation.
Example
{
searchURL: "..."
data: [...],
paging: {...}
}
Attributes
|
Name |
Type |
Description |
|---|---|---|
| searchURL | URL template (string), links to collection list |
URL template for multi-collection searches in all collections in the collection list. By replacing the placeholders in the template with search parameters, a client can search in all collections in the collection list |
|
data |
array of objects |
List of elements in this part of the list. Each element is of the collection format. |
|
paging |
object |
Paging information, which is needed for accessing the remaining parts of the list. For more information, see Paging. |
Remarks
A request does not normally return the full list but only a reasonably-sized part of it. Each part of a list has a unique URL. For more information, see Paging.