Tag

Moduł odpowiedzialny za zarządzanie etykietami - listowanie, tworzenie, modyfikacja, usuwanie.

Endpointy obsługujące żądanie:

• https://api.5ways.com

Pobieranie listy etykiet

GET /rest/tag

Zwraca listę etykiet

Zwracane dane

HTTP/1.1 200 OK
{
    "Tag": {
        "id": "1",
        "customer_id": "82",
        "user_id": "135",
        "name": "Księgowość",
        "color_background": "4455aa",
        "color_text": "ff0055",
        "issue": "1",
        "created": "2018-10-01 11:30:28",
        "modified": "2018-10-01 11:30:28"
    }
},
{
    "Tag": {
        "id": "2",
        "customer_id": "82",
        "user_id": "135",
        "name": "Kadry",
        "color_background": "4455aa",
        "color_text": "ff0055",
        "issue": "1",
        "created": "2018-10-01 11:31:17",
        "modified": "2018-10-01 11:31:17"
    }
}

Pobieranie wybranej etykiety

GET /rest/tag/{id}

Zwraca etykietę

Zwracane dane

HTTP/1.1 200 OK
{
    "Tag": {
        "id": "1",
        "customer_id": "82",
        "user_id": "135",
        "name": "Księgowość",
        "color_background": "4455aa",
        "color_text": "ff0055",
        "issue": "1",
        "created": "2018-10-01 11:30:28",
        "modified": "2018-10-01 11:30:28"
    }
}

Tworzenie etykiety

POST /rest/tag

Tworzy nową etykietę

Treść żądania

{
    "Tag": {
        "user_id": 135,
        "name": "Kadry",
        "color_background": "4455aa",
        "color_text": "ff0055",
        "issue": 1
    }
}

Odpowiedź

Zwraca obiekt z id nowo utworzonej etykiety

HTTP/1.1 201 Created
location: https://api.5ways.com/rest/tag/{id}
{
    "id": 115
}

Modyfikowanie etykiety

PUT /rest/tag/{id}

Modyfikuje dane etykiety

Treść żądania

{
    "Tag": {
        "name": "Prawo"
    }
}

Odpowiedź

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

Usuwanie etykiety

DELETE /rest/tag/{id}

Trwale usuwa etykietę

Odpowiedź

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