Difference between revisions of "REST Interface"

From Transkribus Wiki
Jump to: navigation, search
(Login)
(Collections)
Line 10: Line 10:
  
 
=Collections=
 
=Collections=
<code>https://transkribus.eu/TrpServer/rest/collections/list.xml</code>
+
Once a user is authenticated, the collections, for which the user has access rights, can be listed via the following calls:
 +
* <code>https://transkribus.eu/TrpServer/rest/collections/list.xml</code>
 +
* <code>https://transkribus.eu/TrpServer/rest/collections/list</code> (JSON output)

Revision as of 08:53, 10 September 2015

The Transkribus application communicates with the server via a set of RESTful service methods. The complete definition can be found in the file application.wadl. The parameters for all the methods described below can be found in that service description file.

Login

Most of the methods require the user to be logged in to the services which is achieved by POSTing the user credentials to the login method:
https://transkribus.eu/TrpServer/rest/auth/login
The method returns an XML with the user profile and the collections that are allowed to be accessed by this user.
Subsequent requests to the service must then include the Session-ID from the XML either in:

  • The HTTP header as cookie named "JSESSIONID"
  • The request parameter "JSESSIONID"

Collections

Once a user is authenticated, the collections, for which the user has access rights, can be listed via the following calls: