Skip to main content

Web Service Method: Request Available Collections

Abstract

Web Service Method: Request Available Collections

Description

Returns all collections available for the project.

URL: PoolParty/api/thesaurus/{project}/collections

Request

Supported Methods

GET

Path Variables

Variable

Comment

{project}

The UUID or the URI supplement (textual identifier) of the project to be used.

Response

Array of collections.

Attribute

Type

Comment

uri

String

URI of the collection

title

String

Title of the collection

description

String

Description of the collection

type

String

Is type skos:Collection or skos:OrderedCollection

members

Array

Array containing URIs of concepts that are member of the collection

Example

Example Request

http://<server-url>/PoolParty/api/thesaurus/1DCE489D-9695-0001-E272-285217B0181E/collections

Example Response

[
    {
        "uri": "http://rockefeller.poolparty.biz/testing/2",
        "title": "Developers",
        "description": "People who do development",
        "type": "http://www.w3.org/2004/02/skos/core#Collection",
        "members": [
            "http://rockefeller.poolparty.biz/testing/7",
            "http://rockefeller.poolparty.biz/testing/5",
            "http://rockefeller.poolparty.biz/testing/6"
        ]
    },
    {
        "uri": "http://rockefeller.poolparty.biz/testing/3",
        "title": "Consultants",
        "description": "People who do consulting",
        "type": "http://www.w3.org/2004/02/skos/core#OrderedCollection",
        "members": [
            "http://rockefeller.poolparty.biz/testing/8",
            "http://rockefeller.poolparty.biz/testing/9",
            "http://rockefeller.poolparty.biz/testing/10"
        ]
    }
]