OpenAPI サンプル

最終更新: [ 更新日を記載 ]

GET /persons

List Persons

Retrieves a list of all persons on file in the bat computer.

Status Codes:

  • 200 OK -- An array of Persons

GET /evidence

List Evidence

Retrieves a list of evidence ever found by world's greatest detective and his family.

Query Parameters:

  • marker (integer) -- The id of the last seen evidence. It's used for pagination purpose by returning 'limit' number of evidence after this one.

  • limit (integer) -- The maximum number of evidence to be returned by the query.

Status Codes:

  • 200 OK -- An array of evidence.

POST /evidence

Create an Evidence

Creates a new evidence record in database.

Status Codes:
GET /evidence/{id}

Show Requested Evidence

Queries and returns an evidence with a passed ID.

Parameters:

  • id (integer) -- A unique evidence identifier to query.

Status Codes:
Request Headers:

  • If-None-Match -- Executes a request only if passed ETag doesn't equal to current resource one (i.e. resource has been changed).

Response Headers:

  • ETag -- Entity tag is part of HTTP provided for web cache validation problem, but also used for optimistic concurrency control.