Appointments

This page includes all endpoints available for the agenda appointments of Logiciel Actif (GEM-CAR required).

List all agenda appointments

GET https://app.gem-books.com/api/agenda_appointments

This endpoint allows you to get the list of your appointments. The appointments are returned sorted by most recent number.

Headers

Name	Type	Description
Authentification*	string	Bearer Token
Accept	string	Should be application/json

200: OK

{
    "data": [
        {
            "id": 2,
            "sale_id": 1,
            "sale_product_id": 1,
            "date_at": "2023-01-19",
            "time_at": "00:00:00",
            "workflow_id": 0,
            "duration": "1.00",
            "client_id": 1,
            "vehicle_id": 1,
            "description": null,
            "title": null,
            "date_end": "2023-01-19",
            "time_end": "10:00:00",
            "notes": null,
            "color": null,
            "bay_id": 1
        },
        {
            "id": 1,
            "sale_id": 0,
            "sale_product_id": 0,
            "date_at": "2023-01-18",
            "time_at": "10:00:00",
            "workflow_id": 0,
            "duration": "100.00",
            "client_id": 0,
            "vehicle_id": 0,
            "description": "",
            "title": "TEST",
            "date_end": "2023-02-07",
            "time_end": "11:00:00",
            "notes": null,
            "color": "#519103",
            "bay_id": 2
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 2
    },
    "success": true
}

List a specific agenda appointment

GET https://app.gem-books.com/api/agenda_appointments/:id

This endpoint allows you to get one specific appointment.

Headers

Name	Type	Description
Authentification*	string	Bearer Token
Accept	string	Should be application/json

200: OK

{
    "data": [
        {
            "id": 1,
            "sale_id": 0,
            "sale_product_id": 0,
            "date_at": "2023-01-18",
            "time_at": "10:00:00",
            "workflow_id": 0,
            "duration": "100.00",
            "client_id": 0,
            "vehicle_id": 0,
            "description": "",
            "title": "TEST",
            "date_end": "2023-02-07",
            "time_end": "11:00:00",
            "notes": null,
            "color": "#519103",
            "bay_id": null
        }
    ],
    "success": true
}

Create an agenda appointment

POST https://app.gem-books.com/api/agenda_appointments

Headers

Name	Type	Description
Authentification	string	Bearer Token
Accept	string	Should be application/json

200: OK

{
    "data": [
        {
            "id": 3,
            "sale_id": 0,
            "sale_product_id": 0,
            "date_at": "2023-03-23",
            "time_at": "13:00:00",
            "workflow_id": 0,
            "duration": "2.00",
            "client_id": 0,
            "car_id": 0,
            "description": null,
            "title": null,
            "date_end": "2023-03-23",
            "time_end": "15:00:00",
            "notes": null,
            "color": null,
            "bay_id": null
        }
    ],
    "success": true
}

Body Example

{
    "sale_id": 0,
    "sale_product_id": 0,
    "date_at": "2023-03-23",
    "time_at": "13:00:00",
    "workflow_id": 0,
    "duration": "2.00",
    "client_id": 0,
    "vehicle_id": 0,
    "description": null,
    "title": null,
    "date_end": "2023-03-23",
    "time_end": "15:00:00",
    "notes": null,
    "color": null,
    "bay_id": null
}

Update an appointment

PUT https://app.gem-books.com/api/agenda_appointments/:id

Headers

Name	Type	Description
Authentification	string	Bearer Token
Accept	string	Should be application/json

200: OK

{
    "data": [
        {
            "id": 3,
            "sale_id": 0,
            "sale_product_id": 0,
            "date_at": "2023-03-23",
            "time_at": "13:00:00",
            "workflow_id": 0,
            "duration": "2.00",
            "client_id": 0,
            "car_id": 0,
            "description": null,
            "title": null,
            "date_end": "2023-03-23",
            "time_end": "15:00:00",
            "notes": null,
            "color": null,
            "bay_id": null
        }
    ],
    "success": true
}

Body Example

{
    "sale_id": 0,
    "sale_product_id": 0,
    "date_at": "2023-03-23",
    "time_at": "13:00:00",
    "workflow_id": 0,
    "duration": "2.00",
    "client_id": 0,
    "vehicle_id": 0,
    "description": null,
    "title": null,
    "date_end": "2023-03-23",
    "time_end": "15:00:00",
    "notes": null,
    "color": null,
    "bay_id": null
}

Delete an appointment

DELETE https://app.gem-books.com/api/agenda_appointments/:id

Headers

Name	Type	Description
Authentification	string	Bearer Token
Accept	string	Should be application/json

200: OK

{
    "result": "success",
    "success": true
}