Webová služba Image verze 5.0.0 (Obecné webové služby) - popis rozhraní služby

Vygenerováno z verze 4.21.0.19.0.

Podmínky omezující zveřejnění

Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.

© 2009 MARBES CONSULTING s.r.o.

1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.


Obsah


Obecné informace


Seznam poskytovaných metod

Název Popis
getNextImages Načtení další části stránkovaného seznamu obrázků.
getPersonImages Načtení obrázků osob.

Seznam struktur dat

Název Popis
EosImage
EosImages
EosPaging Objekt obsahující informace pro stránkování.

Výjimky

EosInternalException

Neočekávaná výjimka při volání webových služeb.

EosSessionNotFoundException

Session s předaným id nebyla nalezena.


Popis poskytovaných metod

getNextImages

Načtení další části stránkovaného seznamu obrázků.

Předpis

EosImages getNextImages (String sid, String lid)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
lid String Ano list id

Výstup

EosImages - další část stránkovaného seznamu obrázků

Výjimky

EosSessionNotFoundException - neexistuje session
EosInternalException - vniřní chyba

getPersonImages

Načtení obrázků osob.

Předpis

EosImages getPersonImages (String sid, String personIds, Cz.marbes.eos4.module.ws.v5.image.wo.ImageType imageType)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
personIds String Ano identifikátory osob
imageType Cz.marbes.eos4.module.ws.v5.image.wo.ImageType Ano typ obrázku

Výstup

EosImages - obrázky osob

Výjimky

EosSessionNotFoundException - session nebyla nalezena
EosInternalException - vniřní chyba systému

Popis struktur dat

EosImage

Jméno atributu Datový typ Povinné Popis
entityId String Ne Identifikátor entity.
imageUrl String Ne Url na stažení obrázku.
imageType Cz.marbes.eos4.module.ws.v5.image.wo.ImageType Ne Typ obrázku.
imageHeight int Ne Výška obrázku v pixelech.
imageWidth int Ne Šířka obrázku v pixelech.
checksum String Ne Kontrolní součet.

EosImages

Jméno atributu Datový typ Povinné Popis
images List<EosImage> Ne Obrázky.
paging EosPaging Ne Stránkování.

EosPaging

Objekt obsahující informace pro stránkování.

Jméno atributu Datový typ Povinné Popis
lid String Ne List id nebo null, pokud stránkování není vyžadováno.
start int Ne Index prvního záznamu, který byl aktuálně vrácen.
totalCount int Ne Celkový počáteční záznamů.
hasNext boolean Ne Příznak, zda jsou k dispozici ještě další záznamy.