URL

/garage

Method:

GET

Headers:

None

URL Params

None

Query Params

Optional:

_page=[integer]

_limit=[integer]

If _limit param is passed api returns a header X-Total-Count that countains total number of records.

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    [
      {
        "name": "Tesla",
        "color": "#e6e6fa",
        "id": 1
      }
    ]

  Headers:

    "X-Total-Count": "4"
  

Error Response:

None

Notes:

None

URL

/garage/:id

Method:

GET

Headers:

None

URL Params

Required:

id=[integer]

Query Params

None

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    {
      "name": "Tesla",
      "color": "#e6e6fa",
      "id": 1
    }

Error Response:

• Code: 404 NOT FOUND
  Content:

    {}

Notes:

None

URL

/garage

Method:

POST

Headers:

'Content-Type': 'application/json'

URL Params

None

Query Params

None

Data Params

  {
    name: string,
    color: string
  }

Success Response:

• Code: 201 CREATED
  Content:

    {
        "name": "New Red Car",
        "color": "#ff0000",
        "id": 10
    }

Error Response:

None

Notes:

None

URL

/garage/:id

Method:

DELETE

Headers:

None

URL Params

Required:

id=[integer]

Query Params

None

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    {}

Error Response:

• Code: 404 NOT FOUND
  Content:

    {}

Notes:

None

URL

/garage/:id

Method:

PUT

Headers:

'Content-Type': 'application/json'

URL Params

Required:

id=[integer]

Query Params

None

Data Params

  {
    name: string,
    color: string
  }

Success Response:

• Code: 200 OK
  Content:

    {
        "name": "Car with new name",
        "color": "#ff00ff",
        "id": 2
    }

Error Response:

• Code: 404 NOT FOUND
  Content:

    {}

Notes:

None

URL

/engine

Method:

PATCH

Headers:

None

URL Params

None

Query Params

Required:

id=[integer]

status=['started'|'stopped']

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    {
      "velocity": 64,
      "distance": 500000
    }

Error Response:

• Code: 400 BAD REQUEST
  Content:

  Wrong parameters: "id" should be any positive number, "status" should be "started", "stopped" or "drive"

OR

• Code: 404 NOT FOUND
  Content:

  Car with such id was not found in the garage.

Notes:

None

URL

/engine

Method:

PATCH

Headers:

None

URL Params

None

Query Params

Required:

id=[integer]

status=['drive']

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    {
      "success": true
    }

Error Response:

• Code: 400 BAD REQUEST
  Content:

  Wrong parameters: "id" should be any positive number, "status" should be "started", "stopped" or "drive"

OR

• Code: 404 NOT FOUND
  Content:

  Engine parameters for car with such id was not found in the garage. Have you tried to set engine status to "started" before?

OR

• Code: 429 TOO MANY REQUESTS
  Content:

  Drive already in progress. You can't run drive for the same car twice while it's not stopped.

OR

• Code: 500 INTERNAL SERVER ERROR
  Content:

  Car has been stopped suddenly. It's engine was broken down.

Notes:

• Before using this request you need to switch engine status to the 'started' status first.
• Time when response will finish can be calculated using response from making engine 'started'.
• Engine may fall randomly and at random time at the whole distance.

URL

/winners

Method:

GET

Headers:

None

URL Params

None

Query Params

Optional:

_page=[integer]

_limit=[integer]

_sort=['id'|'wins'|'time']

_order=['ASC'|'DESC']

If _limit param is passed api returns a header X-Total-Count that countains total number of records.

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    [
      {
        "id": 16,
        "wins": 1,
        "time": 2.92
      }
    ]

  Headers:

    "X-Total-Count": "4"
  

Error Response:

None

Notes:

None

URL

/winners/:id

Method:

GET

Headers:

None

URL Params

Required:

id=[integer]

Query Params

None

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    {
        "id": 1,
        "wins": 1,
        "time": 10
    }

Error Response:

• Code: 404 NOT FOUND
  Content:

    {}

Notes:

None

URL

/winners

Method:

POST

Headers:

'Content-Type': 'application/json'

URL Params

None

Query Params

None

Data Params

  {
    id: number,
    wins: number,
    time: number
  }

Success Response:

• Code: 201 CREATED
  Content:

    {
      "id": 109,
      "wins": 1,
      "time": 10
    }

Error Response:

• Code: 500 INTERNAL SERVER ERROR
  Content:

  Error: Insert failed, duplicate id

Notes:

None

URL

/winners/:id

Method:

DELETE

Headers:

None

URL Params

Required:

id=[integer]

Query Params

None

Data Params

None

Success Response:

• Code: 200 OK
  Content:

    {}

Error Response:

• Code: 404 NOT FOUND
  Content:

    {}

Notes:

None

URL

/winners/:id

Method:

PUT

Headers:

'Content-Type': 'application/json'

URL Params

Required:

id=[integer]

Query Params

None

Data Params

  {
    wins: number,
    time: number
  }

Success Response:

• Code: 200 OK
  Content:

    {
      "wins": 2,
      "time": 11,
      "id": 16
    }

Error Response:

• Code: 404 NOT FOUND
  Content:

    {}

Notes:

None