Web Service Method: Request a List of Training Boxes

Description
Get a list of existing training boxes.

URL: /PoolParty/api/classification/{project}/boxes

Content-Type

Content-Type: */*

Request

Supported Methods
GET

Path Variables

VariableDescription
{project}The project UUID or textual identifier

Response

This method returns execution results in JSON format.

JsonBucketList

AttributeType
jsonBoxListArray of JsonBucket
messageString
plainMessageString
reportableboolean
successboolean

Example Response of a JsonBucketList

 {
  "jsonBoxList" : [ {
    "name" : "some name",
    "language" : "nl",
    "uri" : "https://semantic-web.com/api/uri#9163"
  } ],
  "plainMessage" : "some plainMessage",
  "success" : true,
  "reportable" : true,
  "message" : "some message"
}

JsonBucket

AttributeTypeComment
languageStringLanguage of box (en|de|es|fr|...)
nameStringBox name
uriStringBox id

Example Response of a JsonBucket

 {
  "name" : "some name",
  "language" : "nl",
  "uri" : "https://semantic-web.com/api/uri#8514"
}