Zasób zawiera notatki użytkownika.

Endpointy obsługujące żądanie:

• https://api.5ways.com

Pobranie danych

GET /rest/user_notes

Zwróci listę wszystkich notatek.

Odpowiedź

// HTTP/1.1 200 OK
{
    "results": [
        {
            "UserNotes": {
                "id": "259",
                "customer_id": "756",
                "user_id": "3735",
                "title": "Tytuł notatki",
                "body": "Przykładowa treść",
                "archived": "0",
                "created": "2024-03-10 19:27:15",
                "modified": "2024-03-10 19:27:15"
            }
        },
        {
            "UserNotes": {
                "id": "260",
                "customer_id": "756",
                "user_id": "3735",
                "title": "Tytuł innej notatki",
                "body": "Przykładowa inna treść",
                "archived": "1",
                "created": "2024-03-10 19:53:54",
                "modified": "2024-03-10 19:53:54"
            }
        }
    ]
}

Klucze dashboard i sidebar zawierają ustawienia w formacie json.

Tworzenie notatki

POST /rest/user_notes

Treść żądania

{
    "UserNotes": {
        "title": "Tytuł innej notatki",
        "body": "Przykładowa inna treść",
        "archived": "1"
    }
}

Odpowiedź

Zwraca obiekt z wraz z id utworzonej notatki.

// HTTP/1.1 201 Created
{
    "id": "260",
    "customer_id": "756",
    "user_id": "3735",
    "title": "Tytuł innej notatki",
    "body": "Przykładowa inna treść",
    "archived": "1",
    "created": "2024-03-10 19:53:54",
    "modified": "2024-03-10 19:53:54"
}

Aktualizacja danych

PUT /rest/user_notes/{id}

Treść żądania

{
    "UserNotes": {
        "title": "Tytuł zmienionej notatki",
        "body": "Przykładowa, zmienionej treść",
        "archived": "1"
    }
}

Parametr archived przechowuje informacje o stanie zarchiwizowania notatki.

Odpowiedź

HTTP/1.1 200 OK
{
    "status": "OK"
}

Usuwanie notatki

DELETE /rest/user_notes/{id}

Usuwa notatkę.