Geis Point SOAP WebServices Interface Rozhraní pro vložení výdejního místa do objednávky na e-shopu
Verze 20150112 Platnost od 12.1.2015
1
Obsah Obecné informace .................................................................................................................................... 3 Geis Point Plugin WSDL ....................................................................................................................... 3 Popis funkcí .............................................................................................................................................. 3 1)
funkce getRegions ......................................................................................................................... 3
2)
funkce getCities ............................................................................................................................. 5
3)
funkce getGPDetail ........................................................................................................................ 6
4)
funkce searchGP ........................................................................................................................... 8
2
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: http://plugin.geispoint.cz/wsdl/wsdl.php 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 getRegions(string 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
Příklad vstupních dat getRegions('CZ') Příklad výstupních dat (objektového pole) s nalezenými záznamy (po dekódování JSON dat) [0] => stdClass Object ( [id_region] => 19 [name] => Hl. m. Praha ) [1] => stdClass Object ( [id_region] => 27 [name] => Středočeský kraj ) ... Příklad výstupních dat (objektového pole) při chybě (po dekódování JSON dat) [0] => stdClass Object ( [error] => Neplatný kód země )
4
2) funkce getCities(string 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
Příklad vstupních dat getCities('CZ',19)
Příklad výstupních dat (objektového pole) s nalezenými záznamy (po dekódování JSON dat) [0] => stdClass Object ( [id_region] => 19 [city] => Praha 1 ) [1] => stdClass Object ( 5
[id_region] => 19 [city] => Praha 10 ) ...
Příklad výstupních dat (objektového pole) při chybě (po dekódování JSON dat) [0] => stdClass Object ( [error] => Neplatný kód země )
3) funkce getGPDetail(string 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-15001
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ě email – e-mail 6
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ů: -
Zadejte ID GP Zadané ID GP neexistuje Příklad vstupních dat
getGPDetail('VM-15001') Příklad výstupních dat (objektového pole) s nalezenými záznamy (po dekódování JSON dat) [0] => stdClass Object ( [id_gp] => VM-15001 [id_region] => 132 [name] => TRAFIKA,SKLO,PORCELÁN [city] => Kopřivnice [street] => Štefánikova 1239 [zipcode] => 74221 [country] => ČR [email] =>
[email protected] [phone] => 603 154 061 [openining_hours] => Po-Pá 7:00-18:00, So 8:00-12:00 [holiday] => [map_url] => http://www.mapy.cz/s/6nOe [gpsn] => 49.599178118658735 [gpse] => 18.146226100000035 [photo_url] => http://data.e-shoppartner.cz/download/fotovydejny/58586169.jpg [note] => )
7
Příklad výstupních dat (objektového pole) při chybě (po dekódování JSON dat)
[0] => stdClass Object ( [error] => Zadejte ID GP )
4) funkce searchGP(string 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-15001
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
email – e-mail 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
Příklad vstupních dat searchGP('11000','Praha 1','VM-15001') Příklad výstupních dat (objektového pole) s nalezenými záznamy (po dekódování JSON dat) [0] => stdClass Object ( [id_gp] => VM-15001 [id_region] => 132 [name] => TRAFIKA,SKLO,PORCELÁN [city] => Kopřivnice [street] => Štefánikova 1239
9
[zipcode] => 74221 [country] => ČR [email] =>
[email protected] [phone] => 603 154 061 [openining_hours] => Po-Pá 7:00-18:00, So 8:00-12:00 [holiday] => [map_url] => http://www.mapy.cz/s/6nOe [gpsn] => 49.599178118658735 [gpse] => 18.146226100000035 [photo_url] => http://data.eshoppartner.cz/download/fotovydejny/58586169.jpg [note] => )
Příklad výstupních dat (objektového pole) při žádném záznamu (po dekódování JSON dat) [0] => stdClass Object ( [error] => Zadaným parametrům neodpovídá žádný záznam )
10
