SCC API – lista pól nagłówka sprawy

Ważne

Chcąc uzyskać dostęp do API integracyjnego, konieczne jest posiadanie tokena autoryzacyjnego.

Sprawa stanowi powiązanie między kontaktem a kampanią (dlatego będą Ci potrzebne dane o kampaniach). Zawiera informacje związane z obsługą pojedynczego zgłoszenia.

Pobieranie listy dodatkowych pól nagłówka sprawy

Chcąc dodawać do systemu sprawy, możesz potrzebować listy istniejących dodatkowych pól nagłówka sprawy wraz z definicjami.

Ważne

Opisana metoda służy do pobrania listy pól dodatkowych, dostępnych w systemie. Łącznie są to 72 pola różnych typów. Część z nich może być wykorzystana podczas wdrożenia i w Twoim systemie będą one już przypisane do określonych danych (w description widoczna nazwa pola). Pozostałe możesz wykorzystać do przechowywania danych o sprawach ale nie będzie do nich dostępu z poziomu aplikacji (w description Field not defined…).

Uwaga: Może się zdarzyć, że dla różnych kampanii, jedno pole jest wykorzystywane do przechowywania różnych danych, np. do TextField10 sprawy w kampanii A trafiają dane o tytule (description) Preferowany kanał kontaktu, a jeśli sprawa jest w kampanii B to do TextField10 zapisuje się, to co agent wprowadzi do pola nagłówka sprawy o tytule (description) Adres strony internetowej. Przy wywoływaniu pobrania definicji pól nagłówka, dla takich pól otrzymasz informację tyko o jednym z zastosowanych opisów.

Aby pobrać definicje pól nagłówka sprawy wywołaj (dane przykładowe):

GET
IntegrationApi/Case/DefinitionOfExtendedCaseFields

[
    {
        "name": "TextField01",
        "description": "Priorytet",
        "fieldType": "string",
        "format": null
        "maxInput": "250"
        "minInput": null
        "isNullable": false
    }
    [...]
    {
        "name": "IntegerField05",
        "description": "Field not defined in NEXT (Can be used but the data will not be visible on the UI)",
        "fieldType": "int",
        "format": null
        "maxInput": "2147483647"
        "minInput": null
        "isNullable": false
    }
    [...]
    {
        "name": "DecimalField02",
        "description": "Opłata dodatkowa [zł]",
        "fieldType": "decimal(12,4)",
        "format": null
        "maxInput": null
        "minInput": null
        "isNullable": false
    }
     [...]
    {
        "name": "DateTimeField04",
        "description": "Przewidywana data zakończenia",
        "fieldType": "datetime",
        "format": "1900-01-01T00:00:00"
        "maxInput": "9999-12-31T23:59:59"
        "minInput": "1900-01-01T00:00:00"
        "isNullable": false
    }
    [...]
]

Gdzie, w otrzymanym rezultacie:

• name – nazwa pola (będzie potrzebna przy dodawaniu sprawy z uzupełnionym tym polem);
• description – opis, jest widocznym w aplikacji tytułem pola;

Pomocne

Jeśli dane pole nie zostało skonfigurowane jako widoczne, zobaczysz tutaj wartość: Field not defined in NEXT (Can be used but the data will not be visible on the UI).

• field type – to informacja o typie pola, określa m.in. rodzaje znaków, jakie mogą się znaleźć w danym polu;

Pomocne

Wartości jakie przyjmuje field type, to:

• string – to pole tekstowe, przyjmuje wszystkie rodzaje znaków, podlega tylko ograniczeniu ich liczby (wykorzystywane w większości pól, np. imię, nazwisko, adres email);
• int – oznacza pole liczbowe, przyjmujące tylko liczby całkowite, bez znaków specjalnych (wykorzystywane np. jako pole na numer telefonu, jednak nie obsłuży prefiksu +48, można go zastąpić przez 0048);
• decimal(12,4) – także pole liczbowe, jednak dopuszcza do 4. miejsc po przecinku, przyjmuje maksymalnie 12 znaków, przyjmuje wartości ujemne;
• datetime – to pole datowe, przyjmuje dane zgodnie z informacjami podanymi w format, jednak w nagłówku karty sprawy prezentowana będzie tylko data, bez godziny;
• guid – rzadko występujący typ pola, zawiera identyfikatory, np. jak te uzyskiwane w wyniku dodawania spraw lub kontaktów, przyjmuje wartości zgodnie z informacjami w format;
• xml – pole techniczne, bardzo rzadko stosowane, przyjmuje tekst w formacie xml.

• format – parametr występujący tylko dla części typów pól, przedstawia wzorzec danych, jaki przyjmuje dane pole;

Pomocne

Parametr format dla SCC przyjmuje wartości:

• dla pól typu datetime – 1900-01-01T00:00:00;
• dla pól typu guid – 00000000-0000-0000-0000-000000000000;
• dla pozostałych typów pól – NULL, czyli brak wzorca.

• max input – podaje maksymalną wartość, jaką może przyjąć dane pole, dla pól typu string, jest to maksymalna dopuszczalna liczba znaków w tym polu;
• min input – prezentuje minimalną wartość, jaką może przyjąć dane pole, nie dotyczy pól typu string;
• is nullable – informacja czy w danym polu może występować null (brak wartości pola).

Ważne

Pamiętaj, że otrzymasz listę wszystkich skonfigurowanych w systemie pól nagłówka sprawy. Część z nich może być niewidoczna lub dostępna tylko dla wybranej kampanii.

Mając token i dane pól nagłówka sprawy możesz wykonywać przez API inne operacje na danych, na przykład:

 

Dodawanie spraw do systemu

Tworze spraw wymaga znajomości danych kampanii i kontaktów.

Wyszukiwanie spraw w systemie

Umożliwia uzyskanie identyfikatorów spraw spełniających określone parametry.