Obiekty pomocnicze

callerPN

Jest to pole zawierające identyfikator (liczbę) osoby, która wykonała dane zapytanie do API eUczelni (czyli otworzyła stronę, która to zapytanie zadała). W przypadku gdy osoba ta jest anonimowa, lub nie jest możliwe ustalenie jej tożsamości (nie jest zalogowana). Pole to będzie zawierać wartość 0.

fields - pola

fields {
    global_operator         : "AND" | "OR"          // wartość operatora globalnego, który będzie użyty do połączenia wyrażeń field
    array: {
        field: {
            field_name      : "",
             
            // w zależności od typu pola możliwe są następujące wartości:
            // checkbox_field:                      // pole typu true/false
            operator        : { "equal" },
            arguments       : { "value" }
            // text_field:                          // pole tekstowe
            operator        : { "equal" | "contains" | "not equal" | "does not contain" },
            arguments       : { "value" }
            // date_field:                          // pole wyświetlające datę
            operator        : { "equal" | "not equal" | "greater than" | "less than" | "between" },
            arguments       : { "date" | "min", "max" }          // between wykorzystuje pola min i max, wszystkie inne korzystają z value
             // number_field:                       // pole liczbowe
            operator        : { "equal" | "not equal" | "greater than" | "less than" | "between" },
            arguments       : { "value" | "min", "max" }         // between wykorzystuje pola min i max, wszystkie inne korzystają z value
             // list_field:                         // pole wyboru z listy (jednokrotnego)
            operator        : { "equal" | "contains any" | "does not contain any" },
            arguments       : { "selected-value" }
        },
    }
}

sort_order - kolejność sortowania

sort_order:         // porządek w jakim rekordy będą posegregowane, domyślnie: NULL
    array: {
        sort: { 
            field_name      // string       nazwa pola, któego dotyczy sortowanie
            direction       // enum         "asc" - rosnąco, "desc" - malejąco
            cardinality     // int          priorytet sortowania, 0=najwyższy
        },
    }
}

return_params - jak zwracać obiekty, paginacja

return_params:      // parametry zwracane przez funkcję
{
    start           // int,         początkowy rekord, domyślnie: 0
    count           // int,         ilość rekordów jaka będzie zwrócona, domyślnie: 100. 0 oznacza, że żaden rekord nie będzie zwrócony
}

field_name - nazwa pola

Jest to pole typu string, zaweirające pełną nazwę pola z aktualnego modelu. W przypadku błędnej nazwy pola zwrócony zostanie komunikat o błędzie.

response - odpowiedź z systemu

response: {
    error_code      // int          kod błędu: 0 = success, 1-99 = warrning, 100+ = error
    error_desc      // string       opis kodu błędu (ten komunikat zostanie wypisany na ekran w przypadku error_code>0)
    debug_info      // string       informacje dodatkowe dla użytkownika (ten komunikat zostanie wypisany na ekran w przypadku error_code>99)
    cache_time      // int          liczba sekund, przez jaką informacje zwrócone przez to zapytanie powinny być przechowywane w cache. 0 lub ujemne wartości oznaczają, że obiekty przekazane przez to zapytanie nie powinny być cachowane. Pole to ma znaczenie tylko jeśli obiekt response zwraca jakieś obiekty.
    answer          // array        informacja zwrotna (tablica wartości, tablica rekordów) w zależności od tego o co użytkownik prosił
}