API Method: help test

status/test

Returns the string "ok" with a 200 OK HTTP status code.

When used with GET, this is a simple test to see if the REST API is running. When used with POST and a user_id paramater, this is a convenient and non-destructive way to check user credentials (e.g. from in a workflow/batch script).

URL:

GET http://subsift.ilrt.bris.ac.uk/status/test.format
POST http://subsift.ilrt.bris.ac.uk/status/test/user_id.format

Formats (about return formats):

csv, json, rdf, terms, xml, yaml

HTTP Methods (about HTTP methods):

GET, POST

Requires Authentication (about authentication):

false for HTTP method GET
true for HTTP method POST

Usage Examples:

cURL (about cURL):

curl http://subsift.ilrt.bris.ac.uk/status/test.xml

Response (about return values):

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <value>ok</value>
</result>