Aktualizacja danych usług w Widok¶
Udostępnianie danych e-usług¶
-
GET
/performance_api/v1/data/
(string: service)¶ Udostępnia portalowi widok.gov.pl poprzez API dane do wyliczania statystyk dla e-usługi. Każdy dzień to osobny element listy. Dane powinny zawierać aktualny dzień, dwa dni poprzedzające aktualny dzień oraz ewentualne wpisy korygujące wybrany dzień nie starsze niż 30 dni. Dane korygujące nadpiszą dane przechowywane w bazie Widok.
Przykładowe żądanie:
GET /performance_api/v1/data/punkty_karne
Przykładowa odpowiedź:
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "date": "2017-05-01", "user_satisfaction_rate": 99.12, "completion_rate": 95.13, "digital_takeup": 100.00, "number_of_transactions": 123546 }, { "date": "2017-05-02", "user_satisfaction_rate": 98.30, "completion_rate": 97.41, "digital_takeup": 90.00, "number_of_transactions": 23728 }, { "date": "2017-05-03", "user_satisfaction_rate": 98.89, "completion_rate": 97.71, "digital_takeup": 92.70, "number_of_transactions": 18728 } ] }
Request Headers: - Content-Type –
application/json
Parameters: - service (string) – nazwa lub oznaczenie usługi
Response JSON Object: - data (array) –
lista obiektów
-
object
- date (string) – data zbioru danych statystycznych
- user_satisfaction_rate (float) – procentowy wskaźnik zadowolenia użytkownika z dokładnością dwóch miejsc po przecinku (np. 97.13) (niewymagane)
- completion_rate (float) – procentowy stopień ukończenia z dokładnością dwóch miejsc po przecinku (niewymagane)
- digital_takeup (float) – procentowy stopień przejęcia cyfrowego z dokładnością dwóch miejsc po przecinku (niewymagane)
- number_of_transactions (int) – sumaryczna liczba transakcji elektronicznych i tradycyjnych
-
Response Headers: - Content-Type –
application/json
Status Codes: - 200 OK – brak błędu
- 400 Bad Request – błędne zapytanie
- 404 Not Found – serwis o takim identyfikatorze nie istnieje
- Content-Type –
Udostępnianie informacji o kosztach e-usługi¶
-
GET
/performance_api/v1/data/
(string: service)/annual_costs/
(integer: year)¶ Udostępnia portalowi widok.gov.pl poprzez API dane dotyczące rocznego kosztu wdrożenia i utrzymania usługi.
Przykładowe żądanie:
GET /performance_api/v1/data/punkty_karne/annual_costs/2017
Przykładowa odpowiedzi:
HTTP/1.1 200 OK Content-Type: application/json { "year": 2017, "service_annual_cost": 12000000.00 }
Request Headers: - Content-Type –
application/json
Parameters: - service (string) – nazwa lub oznaczenie usługi
- year (string) – rok
Response JSON Object: - year (integer) – rok
- service_annual_cost (float) – roczny koszt usługi
Response Headers: - Content-Type –
application/json
Status Codes: - 200 OK – brak błędu
- 400 Bad Request – błędne zapytanie
- 404 Not Found – serwis o takim identyfikatorze nie istnieje lub dane dla takiego roku nie istnieją
- Content-Type –