...
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
The new Service Layer allows to access EFS key functionalities from outside EFS. Thus, applications relying on EFS data and functionalities can be created outside EFS with quite different technologies. EFS functions which are of interest to customers will be made available as well. The services can be called from outside via HTTP or HTTPS. Various data exchange formats can be used (e.g. JSON). The Service Layer covers the scope of functionality of the old SOAP servicesWeb-Services, which should no longer be used.
Configuring the Services
A dedicated configuration menu allows to view and configure the services which are available on your EFS installation. The menu is in Options → Services Service-Layer → Service configuration. The menu has the same design structure as the menu for the familiar deprecated SOAP services (Options → Services Service-Layer → Web services). The Service configuration menu is only available if Questback’s Support-Team has activated usage of services for your installation. To view and access the menu, you need either read rights for the ACL right webservice_conf or membership in the root team.
...
PHP-serialized: Here, the input and output parameters are transferred as serialized PHP arrays. This is the recommended approach for PHP clients.
To activate the handler, use the URL parameter "handler" with the value "php".
The name of the invoked method is handed over in the URL parameter "meth- od". The method name is structured as follows: MODU- LENAME.ACTORNAME.METHODNAME (separator: periods).
If the request is an HTTP GET request, the description mode will be triggered. Otherwise, the transaction mode will be used.
JSON: Data are transferred in JSON encoding. See the example below.
To activate the handler, use the URL parameter "handler" with the value "json".
The name of the invoked method is handed over in the URL parameter "meth- od". The method name is structured as follows: MODU- LENAME.ACTORNAME.METHODNAME (separator: periods)
If the request is an HTTP GET request, the description mode will be triggered. Otherwise, the transaction mode will be used.
SOAP: SOAP is used to transfer data. See the example below.
To activate the handler, use the URL parameter "handler" with the value "soap".
The name of the invoked method is handed over in the URL parameter "method". The method name is structured as follows: MODU- LENAME_ACTORNAME_METHODNAME (separator: underlines _).
If the URL parameter "wsdl" is set in the request, the description mode will be triggered and a WSDL will be generated. Otherwise, the transaction mode will be used.
REST: See REST API documentation on this page
To activate the handler, use the URL parameter "handler" with the value "rest".
If the URL parameter "raml=1" is set in the request, the description mode will be triggered and a RAML of available API services will be generated. Otherwise, the transaction mode will be used.
...