Skip to main content

    Web Service Method: Request Collection Members

    Abstract

    Web Service Method: Request Collection Members

    Description

    Returns all members of a collection.

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

    Request

    Supported Methods

    GET

    Path Variables

    Variable

    Comment

    {project}

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

    HTTP Parameters

    Parameter

    Comment

    Type

    Required

    collection

    URI of the collection

    String

    true

    Response

    Array of concepts that are member of the collection.

    Attribute

    Type

    Comment

    uri

    String

    URI of concepts that are part of the collection

    URL Pattern

    Request Pattern 

    http://<server-url>/PoolParty/api/thesaurus/<project-uuid>/members?collection=<collection-uri>

    Example

    Example Request 

    http://minor.semantic-web.at/PoolParty/api/thesaurus/1DDFD4E4-ABC7-0001-6DBF-B4D0F47D8230/members?collection=http://minor.semantic-web.at/Test/12

    Example Response for a Regular Collection 

    {
  "ordered" : false,
  "members" : [ {
    "concept" : {
      "uri" : "http://minor.semantic-web.at/Test/1",
      "prefLabel" : "conceptA"
    }
  }, {
    "concept" : {
      "uri" : "http://minor.semantic-web.at/Test/2",
      "prefLabel" : "concpetD"
    }
  } ]
}

    Example Response for an Ordered Collection 

    {
  "ordered" : true,
  "members" : [ {
    "concept" : {
      "uri" : "http://minor.semantic-web.at/Test/2",
      "prefLabel" : "concpetD"
    },
    "sortIndex" : 0
  }, {
    "concept" : {
      "uri" : "http://minor.semantic-web.at/Test/1",
      "prefLabel" : "conceptA"
    },
    "sortIndex" : 1
  } ]
}
    In this section: