flexideo

Příklad služby

Pro další popis vstupních a výstupních formátů zavedeme jednoduchý příklad služby.

Předpokládejme, že služba:

nevyužívá plně REST API flexideo a zavádí statický end-point (rozuměj bez GET parametrizace);

pro svou činnost potřebuje seznam vstupních požadavků v POST body;

vrací opět POST body data dle seznamu požadavků na vstupu;

dle vstupního seznamu jmen, emailů nebo ID vrací odpovídající data kontaktů;


Objektová struktura vstupu a výstupu

Předpokládejme následující aplikační strukturu služby - vstup:

example 
request
get-contacts
name
email
id

Dle zadaných údajů pro každý vstupní požadavek get-contacts dodá patřičný výstupní uzel contact-list.

example 
response
contact-list
contact
name
email
phone
id

Na vstupu může být n požadavků get-contacts, který každý sám o sobě může mít m výsledků. Na výstupu se tedy očekává n x m výsledků.

Koncept práce s formátyPříklad službyKmenový uzel datJSON fomátováníXML fomátování