Metoda ApiSetEventsJson

Transkrypt

1 Metoda ApiSetEventsJson Metoda api-set-events-json odbiera dane w formacie JSON. Metoda wywołana musi być z użyciem a podanego jako główny partnera oraz kodu przydzielonego przez administratora portalu dokis.pl. Administrator portalu wraz z kodem, przekazuje numer identyfikacyjny partnera, który musi być przesłany w każdym wywołaniu metody. Metoda zwraca opis błędu, jeżeli jakiś wystąpił, liczbę przesłanych wydarzeń oraz liczbę poprawnie zapisanych wydarzeń w formacie JSON. Dane obowiązkowe: Nazwa pola Typ Długość Opis partner_id int 11 numer identyfikacyjny partnera nadawany przez administratora portalu dokis.pl id string 255 lokalny numer identyfikacyjny wydarzenia w bazie danych partnera, niezbędny do późniejszej ewentualnej edycji wydarzenia poprzez API platne int 1 informacja czy wydarzenie jest płatne, 0 nie, 1 - tak cykliczne int 1 informacja czy wydarzenie jest cykliczne, 0 nie, 1 - tak czas_start datetime czas rozpoczęcia wydarzenia w formacie yyyy-mm-dd hh:mm czas_koniec datetime czas zakończenia wydarzenia w formacie yyyy-mm-dd hh:mm dla_niepelnosprawnych int 1 informacja czy wydarzenie jest dostępne dla niepełnosprawnych, 0 nie, 1 - tak z_repertuarem int 1 informacja czy wydarzenie jest wydarzeniem zawierającym repertuar, 0 nie, 1 - tak miejscowosc: miejscowosc: nazwa string 255 nazwa miejscowości w której odbywa się wydarzenie, w przypadku nieznalezienia nazwy miejscowości w systemie DOKIS wydarzenie nie zostanie zapisane. System posiada tylko miejscowości z województwa Dolnośląskiego

2 event_wydarzenia_opisy: event_wydarzenia_opisy: język event_wydarzenia_opisy: nazwa event_wydarzenia_kategorie: event_wydarzenia_kategorie: kategoria_id Dane nieobowiązkowe: string 2 język opisu wydarzenia, dozwolone to: 'pl' dla języka polskiego oraz 'en' dla języka angielskiego, opisy muszą być przesłane w obu językach string 255 nazwa wydarzenia Nazwa pola Typ Długość Opis int 11 Numer identyfikacyjny kategorii w portalu dokis.pl, numery oraz opisy kategorii można pobrać za pomocą metody actionapigetcategoriesjson, której dokumentacja znajduje się na stronie czas_trwania time czas trwania wydarzenia w formacie hh:mm:ss (np.: 01:30:00) obrazek_url string 255 link do obrazka na serwerze partnera, obrazek powinien mieć rozmiary co najmniej 1000px (szerokość) na 750px (wysokość) event_wydarzenia_opisy: event_wydarzenia_opisy: podtytul event_wydarzenia_opisy: opis event_wydarzenia_opisy: miejsce event_wydarzenia_opisy: wykonawcy event_wydarzenia_opisy: program event_wydarzenia_opisy: promocja event_wydarzenia_opisy: kategoria_zewnetrzna string 255 podtytuł wydarzenia string bez limitu opis wydarzenia, może mieć formatowanie HTML string 255 dokładne miejsce w którym odbywa się wydarzenie (np. Rynek, Miejskie Centrum Kultury, itp.) string string string bez limitu bez limitu bez limitu opis wykonawców wydarzenia, może mieć formatowanie HTML opis programu wydarzenia, może mieć formatowanie HTML opis promocji na bilety dla całego wydarzenia, może mieć formatowanie HTML string 255 nazwa kategorii wydarzenia w serwisie partnera

3 id data miejsce link wstep_wolny rezerwacja_telefon uklad_miejsc liczba_miejsc liczba_miejsc_wolnych pula_miejsc odwolany dla_niepelnosprawnych audiodeskrypcja liczba_miejsc_dla_niepelnosprawnych promocja adres string 255 lokalny numer identyfikacyjny wydarzenia repertuarowego w bazie danych partnera datetim e data oraz godzina wydarzenia w formacie yyyy-mm-dd hh:mm (np.: :30) string 255 miejsce wydarzenia (np. Scena Kameralna, Scena Główna) string 255 link do sprzedaży biletów, zawierający na początku int 1 informacja czy wydarzenie jest płatne, 1 nie, 0 - tak int 1 informacja czy można rezerwować bilety telefonicznie, 0 nie, 1 - tak string 255 link do strony zawierającej układ miejsc na sali int 11 łączna liczba miejsc na sali int 11 liczba miejsc wolnych na sali int 11 pula miejsc przeznaczonych do sprzedaży na portalu dokis.pl int 1 informacja czy dana pozycja repertuarowa została odwołana, 1 tak, 0 - nie int 1 informacja czy dana pozycja repertuarowa jest dostępna dla osób niepełnosprawnych, 0- nie, 1 - tak int 1 informacja czy dana pozycja repertuarowa będzie zawierała audiodeskrypcję int 11 liczba miejsc przygotowanych dla niepełnosprawnych string bez limitu opis promocji na bilety dla konkretnej pozycji repertuarowej string 255 pełny adres miejsca w którym odbywa się wydarzenie, w formacie, który pozwoli na wyszukanie na mapie google'a

4 event_wydarzenia_repertuar_bilety: event_wydarzenia_repertuar_bilety: nazwa event_wydarzenia_repertuar_bilety: cena string 255 nazwa biletu (normalny, ulgowy, loża, VIP, itp.) float event_wydarzenia_organizatorzy: event_wydarzenia_organizatorzy: nazwa event_wydarzenia_organizatorzy: logo_url event_wydarzenia_mecenasi: event_wydarzenia_mecenasi: nazwa event_wydarzenia_mecenasi: logo_url event_wydarzenia_grupy_wiekowe: event_wydarzenia_grupy_wiekowe: grupa_wiekowa_id event_wydarzenia_zdjecia: event_wydarzenia_zdjecia: zdjecie_url cena biletu string 255 nazwa organizatora wydarzenia, o ile inny niż partner string 255 link do loga organizatora na serwerze partnera string 255 nazwa mecenasa wydarzenia string 255 link do loga mecenasa na serwerze partnera int 11 grupa wiekowa do której skierowane jest wydarzenie, 1 dzieci, 2 dorośli, 3 osoby starsze string 255 link do zdjęcia z galerii wydarzenia na serwerze partnera Przykładowe wywołanie:

5 Konstrukcja przesłanej wiadomości JSON: [ "partner_id": "", "event_wydarzenia": [ "id": "", "platne": "", "cykliczne": "", "czas_start": "", "czas_koniec": "", "dla_niepelnosprawnych": "", "z_repertuarem": "", "czas_trwania": "", "obrazek_url": "", "miejscowosc": [ "nazwa": "" "event_wydarzenia_opisy": [ "jezyk": "pl", "nazwa": "", "podtytul": "", "opis": "", "miejsce": "" "wykonawcy": "", "program": "", "promocja": "", "kategoria_zewnetrzna": "", "jezyk": "en", "nazwa": "", "podtytul": "", "opis": "", "miejsce": "" "wykonawcy": "", "program": "", "promocja": "", "kategoria_zewnetrzna": "" "event_wydarzenia_repertuar": [ "id": "", "data": "", "miejsce": "", "link": "", "wstep_wolny": "",

6 "rezerwacja_telefoniczna": "" "uklad_miejsc": "", "liczba_miejsc": "", "liczba_wolnych_miejsc": "", "pula_miejsc": "", "odwolany": "", "dla_niepelnosprawnych": "", "audiodeskrypcja": "", "liczba_miejsc_dla_niepelnosprawnych": "", "promocja": "", "adres": "" "event_wydarzenia_kategorie": [ "kategoria_id": "" "event_wydarzenia_organizatorzy": [ "nazwa": "", "logo_url": "" "event_wydarzenia_mecenasi": [ "nazwa": "", "logo_url": "" "event_wydarzenia_grupy_wiekowe": [ "grupa_wiekowa_id": "" "event_wydarzenia_zdjecia": [ "zdjecie_url": ""

7 Odpowiedź 404 Not Found w przypadku niepowodzenia autoryzacji lub JSON: "error":"", "number_of_events":"", "number_of_events_saved_correctly":"" Pole error zwraca opis błędu, lub OK jeżeli zapis się powiódł. Zwracane opisy błędu to: No data - brak danych do zapisu, Malformed JSON - błędny zapis przesłanej wiadomości JSON Wrong partner number - nieprawidłowy numer identyfikacyjny partnera, One or more events malformed - nie wszystkie wydarzenia zostały zapisane z powodu błędnych lub niewystarczających danych, OK - wszystko zapisane poprawnie.

8 Wydarzenie repertuarowe to na przykład spektakl teatralny, którego opis jest wspólny dla wszystkich dni i godzin wystawiania tego spektaklu, ale dni i godziny oraz miejsca wystawiania są różne ( np. ). Wydarzenie zwykłe, to wydarzenie, które ma tylko jedną datę i godzinę rozpoczęcia oraz miejsce, w którym się odbywa, np. Przykład wypełnionego zapytania JSON dla wydarzenia zwykłego, o nazwie Festiwal krasnoludków, o lokalnym numerze identyfikacyjnym 760, płatnego, niecyklicznego, niedostępnego dla osób niepełnosprawnych, rozpoczynającego się 28 sierpnia 2014 o godzinie 20:30 i kończącego się 31 sierpnia 2014 o godzinie 12:55, odbywającego się na Wrocławskim Rynku, przypisanego do partnera o numerze identyfikacyjnym 1, należacego do kategorii 1 oraz 10, dostępny dla dzieci i dorosłych: [ "partner_id": 1, "event_wydarzenia": [ "id": "760", "platne": "1", "cykliczne": "0", "czas_start": " :30", "czas_koniec": " :55", "dla_niepelnosprawnych": "0", "z_repertuarem": "0", "obrazek_url": " "miejscowosc": [ "nazwa": "Wrocław" "event_wydarzenia_opisy": [ "jezyk": "pl", "nazwa": "Festiwal krasnoludków", "opis": "<p>opis festiwalu krasnoludków</p><p>drugi akapit opisu festiwalu krasnoludków</p>", "miejsce": "Rynek", "wykonawcy": "<p>wykonawcy</p>", "program": "<p>program</p>", "promocja": "<p>uwaga promocja, przy zakupie 2 biletów, 2 gratis</p>", "kategoria_zewnetrzna": "Festiwal", "jezyk": "en", "nazwa": "Dworf festival", "opis": "<p>description of dworf festival</p><p>second paragraph of the description</p>", "miejsce": "Towns square", "wykonawcy": "<p>artists</p>", "program": "<p>program</p>", "promocja": "<p>discount, if you by 2 tickets, 3 rd is free</p>",

9 "kategoria_zewnetrzna": "Festival" "event_wydarzenia_kategorie": [ "kategoria_id": 10, "kategoria_id": 1 "event_wydarzenia_organizatorzy": [ "nazwa":"oranizator", "logo_url":" pg" "event_wydarzenia_mecenasi":[ "nazwa":"mecenas", "logo_url":" jpg" "event_wydarzenia_grupy_wiekowe":[ "grupa_wiekowa_id":1, "grupa_wiekowa_id":2 "event_wydarzenia_zdjecia":[ "zdjecie_url":" 91.jpg", "zdjecie_url":" 95.jpg"

10 Przykład podobnego wydarzenia w wersji repertuarowej, z dwoma wystawieniami spektaklu, jednym 28 sierpnia 2014 o 20:30, a drugim 31 sierpnia o 12:00, trwające 1,5 godziny, oba bez możliwości rezerwacji telefonicznej, oraz płatne: [ "partner_id": 1, "event_wydarzenia": [ "id": "760", "platne": "1", "cykliczne": "0", "czas_start": " :30", "czas_koniec": " :55", "dla_niepelnosprawnych": "0", "z_repertuarem": "1", "czas_trwania": "01:30:00", "obrazek_url": " "miejscowosc": [ "nazwa": "Wrocław" "event_wydarzenia_opisy": [ "jezyk": "pl", "nazwa": "Spektakl krasnoludków", "opis": "<p>opis spektaklu</p><p>drugi akapit opisu spektaklu</p>", "miejsce": "", "wykonawcy": "<p>wykonawcy</p>", "program": "<p>program</p>", "promocja": "<p>uwaga promocja, przy zakupie 2 biletów, 2 gratis</p>", "kategoria_zewnetrzna": "Spektakl", "jezyk": "en", "nazwa": "Dworf show", "opis": "<p>description of dworf festival</p><p>second paragraph of the description</p>", "miejsce": "", "wykonawcy": "<p>artists</p>", "program": "<p>program</p>", "promocja": "<p>discount, if you by 2 tickets, 3 rd is free</p>", "kategoria_zewnetrzna": "Perfomance" "event_wydarzenia_repertuar": [ "id": "755",

11 "data": " :30", "miejsce": "Rynek", "link": " id=755", "wstep_wolny": "0", "rezerwacja_telefon": "0", "uklad_miejsc": " "liczba_miejsc": "50", "liczba_wolnych_miejsc": "25", "pula_miejsc": "15", "odwolany": "0", "dla_niepelnosprawnych": "0", "audiodeskrypcja": "0", "liczba_miejsc_dla_niepelnosprawnych": "0", "promocja": "<p>promocja: pierwsze 10 biletów o połowę taniej!</p>", "adres": "Wrocław, Rynek 16", "event_wydarzenia_repertuar_bilety": [ "nazwa": "normalny", "cena": "20", "nazwa": "ulgowy", "cena": "10", "id": "756", "data": " :00", "miejsce": "Rynek", "link": " id=756", "wstep_wolny": "0", "rezerwacja_telefon": "0", "uklad_miejsc": " "liczba_miejsc": "50", "liczba_wolnych_miejsc": "25", "pula_miejsc": "15", "odwolany": "0", "dla_niepelnosprawnych": "0", "audiodeskrypcja": "0", "liczba_miejsc_dla_niepelnosprawnych": "0", "promocja": "<p>promocja: pierwsze 10 biletów o połowę taniej!</p>", "adres": "Wrocław, Rynek 16", "event_wydarzenia_repertuar_bilety":[ "nazwa": "normalny",

12 "cena": "20", "nazwa": "ulgowy", "cena": "10" "event_wydarzenia_kategorie": [ "kategoria_id": 10, "kategoria_id": 1 "event_wydarzenia_organizatorzy": [ "nazwa":"oranizator", "logo_url":" pg" "event_wydarzenia_mecenasi":[ "nazwa":"mecenas", "logo_url":" jpg" "event_wydarzenia_grupy_wiekowe":[ "grupa_wiekowa_id":1, "grupa_wiekowa_id":2 "event_wydarzenia_zdjecia":[ "zdjecie_url":" 91.jpg", "zdjecie_url":" 95.jpg"