IssueInitiatorNote

Moduł odpowiedzialny za zarządzanie notatkami przypisanymi do klientów - listowanie, tworzenie, modyfikacja, kasowanie.

Endpointy obsługujące żądanie:

  • https://api.5ways.com

Pobieranie listy klientów

GET /rest/issue_initiator_note

Zwraca listę notatek

Zwracane dane
HTTP/1.1 200 OK
{
    "IssueInitiatorNote": {
        "id": "1",
        "customer_id": "82",
        "issue_initiator_id": "58",
        "title": "Testowa notatka",
        "note": "Treść notatki",
        "created": "2018-03-20 07:43:24",
        "modified": "2018-03-20 07:43:24"
    }
},
{
    "IssueInitiatorNote": {
        "id": "2",
        "customer_id": "82",
        "issue_initiator_id": "58",
        "title": "Testowa notatka dwa",
        "note": "Treść notatki",
        "created": "2018-03-20 07:43:24",
        "modified": "2018-03-20 07:43:24"
    }
}

Pobieranie wybranej notatki

GET /rest/issue_initiator_note/{id}

Zwraca dane notatki na podstawie podanego ID

Zwracane dane
HTTP/1.1 200 OK
{
    "IssueInitiatorNote": {
        "id": "2",
        "customer_id": "82",
        "issue_initiator_id": "58",
        "title": "Testowa notatka dwa",
        "note": "Treść notatki",
        "created": "2018-03-20 07:43:24",
        "modified": "2018-03-20 07:43:24"
    }
}

Tworzenie notatki

POST /rest/issue_initiator_note

Tworzy nowej notatki

Treść żądania
{
    "IssueInitiatorNote": {
        "issue_initiator_id": "58",
        "title": "Testowa notatka trzy",
        "note": "Treść notatki"
    }
}
Odpowiedź

Zwraca obiekt z id nowo utworzonej notatki

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

Modyfikowanie notatki

PUT /rest/issue_initiator_note/{id}

Modyfikuje notatkę

Treść żądania
{
    "issue_initiator_note": {
        "title": "Nowy tytuł"
    }
}
Odpowiedź
HTTP/1.1 200 OK
{
    "status": "OK"
}

Usuwanie notatki

DELETE /rest/issue_initiator_note/{id}

Trwale usuwa notatkę

Odpowiedź

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