List a collection's documents - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service lists all the documents in a selected collection that was previously added to the user's library.

Method Endpoint
GET 
/api/users/{userId}/collections/{collectionId}/documents
Path parameter Type Description
{userId} String The user's identifier. See the List users or Search users web services to find a user's ID. It is also possible to get a user's ID from the Manage users menu.
{collectionId} String The identifier of the collection as retrieved when listing collections.

It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.

Response body

The following lines show an example of a JSON response body:

[
  {
    "id": "ANQIG6TskpgvVs2mKUEt7Q",
    "title": "Document one",
    "type": "MAP",
    "deleted": false,
    "apiUrl": "https://docs.fluidtopics.com/api/khub/maps/ANQIG6TskpgvVs2mKUEt7Q",
    "portalUrl": "https://docs.fluidtopics.com/r/Document-one"
  }
]
Field Type Description
id String The identifier of the document.
title String The title of document.
type String The type of document. Possible values are MAP for structured documents (books or articles), DOCUMENT for unstructured documents, PERSONAL_BOOK for personal books and SHARED_BOOK for shared personal books.
deleted Boolean Possible values are true and false.
apiUrl String A URL to more information about the document (see associated web services for structured and unstructured documents).
portalUrl String The pretty URL of the document in the Fluid Topics portal.

For static collections, if a document is removed from the portal, apiUrl and portalUrl are not returned and the deleted parameter is set to true.

Return code Description
200 OK Returns 0 or more results.