GET /bonsais
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| status | string | query | Filter the bonsais by status. Can be alive, unknown or dead |
| older_than | string | query | Only return bonsais which age is greater than |
| sort | string | query | The field to sort the result by. Can be either status, age (last_watering, last_repotting, last_pruning: optional) |
| direction | string | query | Sort direction. Can only be asc or desc. Default is desc |
Response
[
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"acquisition_date": "10-06-2021",
"acquisition_age": 25,
"owner_id": "XXXXXX",
"last_watering": "20-09-2021",
"last_repotting":"10-02-2019",
"last_pruning": "30-04-2021",
"status": "alive"
}
]POST /bonsais Body:
{
"name": "Pépito",
"species": "Jade tree",
"acquisition_date": "10-06-2021",
"acquisition_age": 25,
"owner_id": "6d009e8f-a55f-4ca0-9ef9-5ff6f79478fb"
}Parameters
| Name | Type | In | Description |
|---|---|---|---|
| name | string | body | Required. Name of the bonsai to create |
| species | string | body | Species of the bonsai |
| acquisition_date | string | body | Date of acquisition |
| acquisition_age | string | body | Age of the bonsai when it was bought |
| owner_id | string | body | Id of the owner |
Response
201 Created
Location header sent
[
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"acquisition_date": "10-06-2021",
"acquisition_age": 25,
"owner_id": "6d009e8f-a55f-4ca0-9ef9-5ff6f79478fb",
"last_watering": "20/09/2021",
"last_repotting":"10/02/2019",
"last_pruning": "30/04/2021",
"status": "alive"
}
]GET /bonsais/{id}
or
GET /bonsais/{name} Response 200 OK
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"acquisition_date": "10-06-2021",
"acquisition_age": 25,
"owner_id": "6d009e8f-a55f-4ca0-9ef9-5ff6f79478fb",
"last_watering": "20-09-2021",
"last_repotting":"10-02-2019",
"last_pruning": "30-04-2021"
}Resource not found
404 Not found Input error 400 Bad request The requested bonsai is dead 410 Gone The request bonsai has changed name 301 Moved permanently
Locationheader sent
PATCH /bonsais/{id}
{
"name": "Pépito",
"species": "Jade tree",
"acquisition_date": "10-06-2021",
"acquisition_age": 25,
}Parameters
| Name | Type | In | Description |
|---|---|---|---|
| name | string | body | Name of the bonsai to create |
| species | string | body | Species of the bonsai |
| acquisition_date | string | body | Date of acquisition |
| acquisition_age | string | body | Age of the bonsai when it was bought |
Response
200 OK
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"acquisition_date": "10-06-2021",
"acquisition_age": 25,
"owner_id": "6d009e8f-a55f-4ca0-9ef9-5ff6f79478fb",
"last_watering": "20-09-2021",
"last_repotting":"10-02-2019",
"last_pruning": "30-04-2021"
}Resource not found
404 Not found Input error 400 Bad request
DELETE /bonsais/{id}
Response
204 No content Resource not found 404 Not found Input error 400 Bad request
PUT /bonsais/{id}/status Body :
{"status": "dead"}Parameters
| Name | Type | In | Description |
|---|---|---|---|
| status | string | body | Required. Allowed statuses are dead, alive andunknown |
Response
204 No content Resource not found 404 Not found Input error 400 Bad request
GET /bonsais/{id}/watering Response 200 OK
[
{
"id": "22dd930c-fe5d-497d-9b60-462f2083541d",
"datetime": "2022-07-24 18:24:33"
}
]GET /bonsais/{id}/repotting
Response 200 OK
[
{
"id": "22dd930c-fe5d-497d-9b60-462f2083541d",
"datetime": "2022-07-24 18:24:33"
}
]GET /bonsais/{id}/pruning Response 200 OK
[
{
"id": "22dd930c-fe5d-497d-9b60-462f2083541d",
"datetime": "2022-07-24 18:24:33"
}
]GET /owners Parameters
| Name | Type | In | Description |
|---|---|---|---|
| has_more | integer | body | Returns the owner who have more or the same number of bonsais than this parameter |
Response
[
{
"id": "c95f4c10-a520-4a5c-8a1e-6179eb5cd4e0",
"name": "Pépito",
"bonsais": [
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"age": 25
}
]
}
]GET /owners/{id} Response
{
"id": "c95f4c10-a520-4a5c-8a1e-6179eb5cd4e0",
"name": "Pépito",
"bonsais": [
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"age": 25
}
]
}Resource not found
404 Not found
POST /owners Body :
{
"name": "Pépito",
}Response
201 Created
Locationheader sent
{
"id": "3af50eed-c674-41fc-b7a6-5d0667a4c1fa",
"name": "Jean-Hugues",
"bonsais": [
]
}| Name | Type | In | Description |
|---|---|---|---|
| name | string | body | Required. The name of the owner. |
| bonsais | array of objects | body | The bonsais of the future owner. Can be an empty array or omitted. |
GET /owners/{id}/bonsais Response 200 OK
[
{
"id": "63696432-01a2-4b43-b162-47b4f1e6062a",
"name": "Pépito",
"species": "Jade tree",
"acquisition_age": 25
}
]Resource not found
404 Not found
POST /owner/{owner_id}/bonsais/{bonsai_id}/transfer Body :
{ "owner_id": "5c4eb5ad-e825-4444-bbe1-18639330a2a8" }| Name | Type | In | Description |
|---|---|---|---|
| owner_id | string | path | The id of the current owner |
| bonsai_id | string | path | The id of the bonsai to transfer |
| new_owner | string | body | Required The id of the new owner |
Response :
{
"id": "bcb745af-838e-4241-aff4-dc5df67756bb",
"name": "Pépito",
"species": "Jade tree",
"acquisition__age": 25,
}POST /owner/{owner_id}/bonsais Body :
["5c4eb5ad-e825-4444-bbe1-18639330a2a8","5c4eb5ad-e825-4444-bbe1-18639330a2a8"]| Name | Type | In | Description |
|---|---|---|---|
| owner_id | string | path | The id of the current owner |
| bonsai_id | string | body | Required The ids of the bonsai to transfer |
Response :
204 No content If a bonsai already belongs to another owner, it will be ignored.