Web Services exposed¶

WEB SERVICE WSDL¶

These are the Web Service WSDLs available in eTB Manager:

• Authenticator Services https://www.etbmanager.org/etbmanager/services/authentication?wsdl
• Data Exchange Services https://www.etbmanager.org/etbmanager/services/exchange?wsdl
• Xpert Services https://www.etbmanager.org/etbmanager/services/xpertservice?wsdl

WEB SERVICE MESSAGE FORMAT¶

In general, the standard communication format between client and server using Web Services is the XML format. All server responses are returned in XML format, and when the arguments of the Web Service require a complex structure (for example, structured data containing patient information), it’s also given in a XML format.

Message Response format – All eTB Manager service calls will return an XML with a single response node, containing the result of the call (if successfully executed) and an error code and an error message fields (if an error occurred during the call). Below is an example of an XML response:

<response>
   <result>68225be49a004f798cb17e11142ba3d1</result>
   <errorno>0</errorno>
   <errormsg/>
</response>

This is an example of a response call from the authenticator service. The first field to be examined is the errorno node, which indicates if the service call was executed successfully (0) or if there was an error during execution (different from 0). The possible values of the errorno field are:

Errorno Meaning¶

• 0 The call was successfully executed.
• 1 Authentication failed. User name, password or workspace are not valid. returned only by the authenticator service.
• 2 The sessionID provided is not valid. You must authenticate again.
• 3 Unexpected error. This is not common and it’s better to contact the system administrator when it happens. Check the errormsg field for more information.
• 4 Validation error. It is caused when the information didn’t pass the validation rules of the method call, for example, a required field that is null. Check the errormsg field for more information.

STANDARD TYPE FORMATS¶

In the table below you’ll find the list of supported types and its string format in XML: