Click or drag to resize
Built-in webservices

[This is preliminary documentation and is subject to change.]

The TOPICA Framework includes a set built-in SOAP web services, that define an API. This API contains functioniality for almost all parts of TOPICA. That is, almost anything that can be done interactively in the user interface, may be done using this API.

In TOPICA releases 4.23 and later, there is a menu item in the main menu, that list the built-in webservices (one service = one .asmx-file).

  • One service = one .asmx-file

  • Each service is clickable. Clicking on the service (.asmx-file) displays the methods in that service.

    This is the standard test-page auto generated for services implemented in ASP.NET.

  • Each method is also clickable. Clicking on a method shows how to call each method (SOAP XML syntax).

    Methods that only take prameters of simple types may be invoked. It is possible to enter values for the parameters, and get the result displayed as XML.

    Almost all methods take a SessionGuid parameter (of type Guid). Because Guid is not a simple type, these methods cannot be invoked. Many methods, that only take parameters of simple type (except for SessionGuid), have a corresponding Test method

Use this functionality as the primary documentation of the services, as this is automatically updated (the information in this documentation may not to be fully updated).

List of services

Service name

Description

SystemService

This service operates at the system level, i.e. not aon any specific configuration. (All other services work on a specific configuration).

LoginService

Used to log in and log out.

If a log in operation succeeds, a token (call "session guid") is returned. This "session guid" must be supplied to most other services.

OrgUnitService

Working on the organization

EmployeeService

Working with employees (including users).

PatientService

Working with patients - incluing patient record data.

ClassificationService

Working with classifications.

DataDictionaryService

Working with Data Dictionary (meta data describing the dynamic data model)

XmlIntegrationService

???

TopicaBasicService

Evaluating TOPICA Basic expressions.

Optional section title

Add one or more sections with content