SOAP-berichten
De Easyflex dataservice is een interface die via SOAP/XML een koppeling mogelijk maakt tussen uw website/applicatie en de Easyflex database. Het protocol dat gebruikt wordt is SOAP (RPC) over HTTPS. Tevens is er een WSDL (Web Services Definition Language) document beschikbaar waarmee veel SOAP clients overweg kunnen om eenvoudig de web- en dataservice aan te spreken.
SOAP request
Ieder dataservice request bestaat uit drie delen:
- License: De key voor de web- en dataservice dient altijd mee te worden gestuurd. De key wordt gebruikt voor de authenticatie.
- Parameters: Veel web- en dataservice requests hebben een aantal parameters nodig voor het leveren of wijzigen van de juiste data. De parameters met hun waarde bevinden zich altijd binnen dit deel. Een parameter kan bijvoorbeeld het registratienummer (regnr) van een flexwerker zijn. Indien gebruik wordt gemaakt van speciale karakters zullen deze middels xml-encoding moeten worden omgezet omdat ze anders niet in de database kunnen worden opgeslagen. Bijvoorbeeld de letter U moet worden omgezet naar Ú Binnen Easyflex gebruiken we de volgende opties om aan te geven of een parameter verplicht is.
| Code | Betekenis | Omschrijving |
|---|---|---|
| V | Verplicht | Parameter moet meegegeven worden. |
| O | Optioneel | Parameter mag meegegeven worden, indien deze meegegeven wordt mag deze niet leeg zijn. |
| F | Facultatief | Parameter mag meegegeven worden, indien deze meegegeven wordt mag deze leeg zijn. |
| C | Conditioneel | Parameter is in bepaalde gevallen verplicht. |
- Fields: De web- en dataservice requests hebben als doel het ophalen en opslaan van data. Om overhead te voorkomen zijn de dataservices zo gebouwd, dat er aangegeven kan worden welke velden moeten worden geleverd. Zo kan bijvoorbeeld alleen het geslacht van de flexwerker opgehaald worden zonder dat alle andere persoonsgegevens geretourneerd zullen worden. De web- en dataservices zullen de gevulde velden in dezelfde volgorde leveren als is opgevraagd. Indien geen fields in het request worden opgenomen zullen alle fields, zoals ze zijn gedefinieerd in de web- en dataservices, worden geretourneerd.
- (Indien webservice) Session: De sessiecode van huidig ingelogde gebruiker. Deze wordt gebruikt voor de authenticatie van de ingelogde gebruiker. Dit kan een flexwerker zijn, maar ook een relatie of medewerker van een relatie. De sessiecode hoeft niet in alle gevallen meegestuurd te worden. Deze hoeft alleen meegestuurd te worden bij het opvragen en wijzigen van gegevens waarvoor een gebruiker ingelogd dient te zijn.
SOAP response
Een correct dataservice response bestaat uit twee delen:
- Signature: In de Soap Header bevindt zich de informatie om te kunnen controleren dat de data ook echt van Easyflex afkomstig is.
- Fields: Binnen dit deel bevinden zich de gevraagde velden met hun waarden. Deze zullen altijd geleverd worden in dezelfde volgorde als is opgevraagd. Indien er geen velden zijn gespecificeerd worden alle standaard velden geleverd.
- (Indien webservice) Session: De nieuwe sessiecode van de huidige ingelogde gebruiker. Deze dient de volgende keer meegestuurd te worden aangezien een sessiecode slechts een beperkte tijd geldig is.