Webová služba ContactRead verze 2.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

Rozhraní webové služby pro práci s kontakty.

Seznam poskytovaných metod

Název Popis
getAllContactInfos Vrátí seznam všech druhů kontaktů.

Seznam struktur dat

Název Popis
EosContactInfo Reprezentuje druh kontaktu.
EosContactInfos Reprezentuje kolekci druh; kontaktů.
EosContactType Reprezentuje typ kontaktního atributu.
EosContactTypeCategory Reprezentuje kategorii typu kontaktního atributu.
EosIdentifier Reprezentuje identifikátor webového objektu slučující interní a externí ID.

Výjimky


Popis poskytovaných metod

getAllContactInfos

Vrátí seznam všech druhů kontaktů.

Předpis

EosContactInfos getAllContactInfos (String clientId)

Parametry

Parametr Typ Povinný Popis
clientId String Ne id klienta

Výstup

EosContactInfos - seznam všech konatktních atributů

Popis struktur dat

EosContactInfo

Reprezentuje druh kontaktu.
Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
name String (255) Ano Název.
displayName String (256) Ano Zobrazované jméno
contactType EosContactType Ano Typ kontaktu.
contactTypeCategory EosContactTypeCategory Ano Kategorie typu kontaktu.
publicable Boolean Ne Vyjadřuje zda je kontakt možné zveřejnit.

EosContactInfos

Reprezentuje kolekci druh; kontaktů.
Jméno atributu Datový typ Povinné Popis
contactInfo List<EosContactInfo> Ano Kolekce telefonů(fax, mobil, ...).

EosContactType

Reprezentuje typ kontaktního atributu.
Hodnota Popis
PHONE Telefon.
FAX Fax.
EMAIL Email.
WWW WWW.

EosContactTypeCategory

Reprezentuje kategorii typu kontaktního atributu.
Hodnota Popis
HOME Domů.
WORK Do práce.
MOBILE Mobilní.
BLANK Bez kategorie.

EosIdentifier

Reprezentuje identifikátor webového objektu slučující interní a externí ID.

Jméno atributu Datový typ Povinné Popis
externalId String (255) Ne Id entity v externím systému.
eosIdentifier String (255) Ne Unikátní identifikátor entity v EOSu (v rámci konkrétního potomka entity, tedy např. organizační role), při importu do EOSu nemá význam.