Skip to main content

API Challenges Simple Todo List

A Simple todo list

Use the Content-Type header to define the payload content e.g.

Content-Type: application/json

Set Content-Type header to application/xml, text/xml, or a model-matching application/*+xml media type if you want to send in XML.

Content-Type: application/xml

Content-Type: text/xml

Content-Type: application/todo+xml

You can control the returned data format by setting the Accept header

You can request XML response by setting the Accept header.

i.e. for XML use

Accept: application/xml
Accept: text/xml
Accept: application/*+xml

You can request JSON response by setting the Accept header.

i.e. for JSON use

Accept: application/json

Additional response Accept headers are supported.

Accept: text/csv
Accept: text/plain
Accept: text/html
Accept: application/x-ndjson
Accept: application/jsonl
Accept: application/json-seq
Accept: text/tab-separated-values

Some requests can be filtered by adding query params of fieldname=value. Where only matching items will be returned.

Filter conditions can use field=value for equals, field!=value or field!value for not equals, field<value, field>value, field<=value, and field>=value for comparisons, field~=regex for regular expression matches, and field*=wildcard for wildcard matches where * matches many characters and ? matches one character. Multiple query params are combined as AND conditions.

e.g. /thing?size=2&status=true

Some requests can be sorted by adding the _sortBy query param with a field name. Use _sortBy=+field or _sortBy=field for ascending order, and _sortBy=-field for descending order. Multiple fields can be combined with commas, e.g. _sortBy=+field,-other.

Collection requests can be paged with _limit=limit and _offset=offset. Offset is zero-based, the default limit is 10, and the maximum limit is 20.

Model

Things

todo

Fields:
Fieldname Type Description
idAUTO_INCREMENT
  • Field is an ID and should not be amended or set
Example: "88"
titleSTRING
  • The title of the TODO Item
  • Value is mandatory
  • Value can not be empty
  • Maximum length allowed is 50
Example: "A title"
doneStatusBOOLEAN
  • Status to track the todo completion
  • Value must be a Boolean (true, false) value
Example: "false"
descriptionSTRING
  • Longer description of the todo
  • Maximum length allowed is 200
Example: "my description"

Example JSON Output from API calls


{
  "todos": [
    {
      "id": 88,
      "title": "A title",
      "doneStatus": false,
      "description": "my description"
    }
  ]
}

Example XML Output from API calls


<todos>
  <doneStatus>false</doneStatus>
  <description>my description</description>
  <id>88</id>
  <title>A title</title>
</todos>

Example JSON Input to API calls


{
  "id": 1,
  "title": "A title",
  "doneStatus": false,
  "description": "my description"
}

Example XML Input to API calls


<todo>
  <doneStatus>false</doneStatus>
  <description>my description</description>
  <id>1</id>
  <title>A title</title>
</todo>

secrettoken

Fields:
Fieldname Type Description
idSTRING
  • Value is mandatory
Example: "se cillum dolore eua"
tokenSTRING
  • Value is mandatory
Example: "ad minim veniam, qua"
Views:
View Request Fields Response Fields Input Allowed Fields
SecretTokenResponsetokentokenid, token

Example JSON Output from API calls


{
  "secrettokens": [
    {
      "id": "se cillum dolore eua",
      "token": "ad minim veniam, qua"
    }
  ]
}

Example XML Output from API calls


<secrettokens>
  <id>se cillum dolore eua</id>
  <token>ad minim veniam, qua</token>
</secrettokens>

Example JSON Input to API calls


{
  "id": "se cillum dolore eua",
  "token": "ad minim veniam, qua"
}

Example XML Input to API calls


<secrettoken>
  <id>se cillum dolore eua</id>
  <token>ad minim veniam, qua</token>
</secrettoken>

secretnote

Fields:
Fieldname Type Description
idSTRING
  • Value is mandatory
Example: "eniam, quis nostruda"
noteSTRING
  • Value is mandatory
  • Maximum length allowed is 100
Example: "dent, sunt in culpaa"
Views:
View Request Fields Response Fields Input Allowed Fields
SecretNoteResponsenotenoteid, note

Example JSON Output from API calls


{
  "secretnotes": [
    {
      "id": "eniam, quis nostruda",
      "note": "dent, sunt in culpaa"
    }
  ]
}

Example XML Output from API calls


<secretnotes>
  <note>dent, sunt in culpaa</note>
  <id>eniam, quis nostruda</id>
</secretnotes>

Example JSON Input to API calls


{
  "id": "eniam, quis nostruda",
  "note": "dent, sunt in culpaa"
}

Example XML Input to API calls


<secretnote>
  <note>dent, sunt in culpaa</note>
  <id>eniam, quis nostruda</id>
</secretnote>

API

The API takes body with objects using the field definitions and examples shown in the model.

End Points

/api/todos

e.g. /api/todos

This endpoint can be filtered with fields as URL Query Parameters.

e.g. /api/todos?title=A%20title

This endpoint can be sorted with the _sortBy URL Query Parameter. Use _sortBy=+field or _sortBy=field for ascending order, and _sortBy=-field for descending order. Multiple fields can be combined with commas, e.g. _sortBy=+field,-other.

e.g. /api/todos?_sortBy=+id

This endpoint can be paged with the _limit and _offset URL Query Parameters.

e.g. /api/todos?_limit=10&_offset=0

QUERY form content uses Content-Type: application/x-www-form-urlencoded with fields such as title=Task&_sortBy=-id.

QUERY JSONPath content uses Content-Type: application/jsonpath with an expression such as $['todos'][?@['title'] == 'Task'].

QUERY structured JSON content uses Content-Type: application/vnd.thingifier.query+json with a JSON query object.

/api/todos/:id

e.g. /api/todos/:id

/api/secret/token

e.g. /api/secret/token

/api/secret/note

e.g. /api/secret/note

/api/secret/token

e.g. /api/secret/token

/api/secret/note

e.g. /api/secret/note

/api/challenger/:guid

e.g. /api/challenger/:guid

/api/challenger

e.g. /api/challenger

/api/challenger/database/:guid

e.g. /api/challenger/database/:guid

/api/challenges

e.g. /api/challenges

/api/heartbeat

e.g. /api/heartbeat

/api/todos/export

e.g. /api/todos/export

Find OpenAPI file and OpenAPI Powered Client UIs like Swagger and Scalar here

 

Copyright Compendium Developments Ltd 2020 - 2026