Geis Point SOAP WebServices Interface

Transkript

1 Geis Point SOAP WebServices Interface Rozhraní pro vložení výdejního místa do objednávky na e-shopu Verze Platnost od

2 Obsah Obecné informace... 3 Geis Point Plugin WSDL... 3 Popis funkcí funkce getregions funkce getcities funkce getgpdetail funkce searchgp

3 Obecné informace Geis Point Plugin WSDL Jedná se o webservices rozhraní, kdy jsou na základě vstupních dat vrácena data WSDL a to rozhraním ve formátu JSON. Tento formát dat je pak snadno zpracovatelný v jazycích PHP, ASP či Java, případně i v aplikacích pro ios či Android. WSDL URL: Na této adrese najdete definici WSDL, seznam jednotlivých funkcí a vstupních parametrů Níže si popíšeme dané funkce, vstupní a výstupním data + chybové stavy. Popis funkcí 1 funkce getregionsstring country_code Tato funkce slouží k vrácení seznamů dostupných krajů výdejních míst. Vstupní data country_code string kód země, pro Českou republiku použijeme CZ Výstupní data Výstupem je objektové JSON pole: a v případě nalezení záznamů obsahuje tyto prvky: id_region ID kraje name název kraje b v případě chyby: error popis chyby, seznam možných chybových stavů: - Neplatný kód země 3

4 Příklad vstupních dat getregions'cz' [1] => stdclass... Příklad výstupních dat objektového pole s nalezenými záznamy [id_region] => 19 [name] => Hl. m. Praha [id_region] => 27 [name] => Středočeský kraj po dekódování JSON dat Příklad výstupních dat objektového pole při chybě po dekódování JSON dat [error] => Neplatný kód země 4

5 2 funkce getcitiesstring country_code, int id_region Tato funkce slouží k vrácení seznamů dostupných měst výdejních míst. Vstupní data country_code string kód země, pro Českou republiku použijeme CZ id_region int ID kraje, které jsme dostali vráceno ve funkci getregions Výstupní data Výstupem je objektové JSON pole: a v případě nalezení záznamů obsahuje tyto prvky: id_region ID kraje name název města b v případě chyby: error popis chyby, seznam možných chybových stavů: - Neplatný kód země - Kód kraje musí být číslo - Zadaný kód kraje neexistuje getcities'cz',19 Příklad vstupních dat Příklad výstupních dat objektového pole s nalezenými záznamy po dekódování JSON dat [1] => stdclass [id_region] => 19 [city] => Praha 1 5

6 ... [id_region] => 19 [city] => Praha 10 Příklad výstupních dat objektového pole při chybě po dekódování JSON dat [error] => Neplatný kód země 3 funkce getgpdetailstring id_gp Tato funkce slouží k vrácení detailních informací o výdejním místě GP. Vstupní data id_gp string ID výdejního místa GP, např. VM Výstupní data Výstupem je objektové JSON pole: a v případě nalezení záznamů obsahuje tyto prvky: id_gp ID výdejního místa id_region ID kraje name název city město street ulice zipcode PSČ country země 6

7 phone telefon openining_hours otevírací doba holiday dovolená map_url odkaz na mapu gpsn GPS latitude gpse GPS longitude photo_url URL s fotografií výdejního místa note - poznámka b v případě chyby: error popis chyby, seznam možných chybových stavů: getgpdetail'vm-15001' - Zadejte ID GP - Zadané ID GP neexistuje Příklad vstupních dat Příklad výstupních dat objektového pole s nalezenými záznamy po dekódování JSON dat [id_gp] => VM [id_region] => 132 [name] => TRAFIKA,SKLO,PORCELÁN [city] => Kopřivnice [street] => Štefánikova 1239 [zipcode] => [country] => ČR [ ] => maersro@post.cz [phone] => [openining_hours] => Po-Pá 7:00-18:00, So 8:00-12:00 [holiday] => [map_url] => [gpsn] => [gpse] => [photo_url] => [note] => 7

8 Příklad výstupních dat objektového pole při chybě po dekódování JSON dat [error] => Zadejte ID GP 4 funkce searchgpstring zipcode, string city, string id_gp Tato funkce slouží k vyhledání výdejních míst podle vstupních parametrů: PSČ, město či ID výdejního místa GP. Vstupní parametry jsou provázány funkcí OR, pokud nezadáte žádný parametr, pak Vám budou vráceny všechny záznamy. Vstupní data zipcode string PSČ požadované lokality city string název města, které nám bylo vráceno ve funkcni getcities id_gp string ID výdejního místa GP, např. VM Výstupní data Výstupem je objektové JSON pole: a v případě nalezení záznamů obsahuje tyto prvky: id_gp ID výdejního místa id_region ID kraje name název city město street ulice zipcode PSČ country země 8

9 phone telefon openining_hours otevírací doba holiday dovolená map_url odkaz na mapu gpsn GPS latitude gpse GPS longitude photo_url URL s fotografií výdejního místa note - poznámka b v případě chyby: error popis chyby, seznam možných chybových stavů: - Zadaným parametrům neodpovídá žádný záznam - Zadejte alespoň jeden parametr searchgp'11000','praha 1','VM-15001' Příklad vstupních dat Příklad výstupních dat objektového pole s nalezenými záznamy [id_gp] => VM [id_region] => 132 po dekódování JSON dat [name] => TRAFIKA,SKLO,PORCELÁN [city] => Kopřivnice [street] => Štefánikova

10 [zipcode] => [country] => ČR [ ] => [phone] => [openining_hours] => Po-Pá 7:00-18:00, So 8:00-12:00 [holiday] => [map_url] => [gpsn] => [gpse] => [photo_url] => [note] => Příklad výstupních dat objektového pole při žádném záznamu po dekódování JSON dat [error] => Zadaným parametrům neodpovídá žádný záznam 10