Difference between revisions of "REST Interface"

From Transkribus Wiki
Jump to: navigation, search
(Login)
(Login)
Line 3: Line 3:
 
=Login=
 
=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:<br/>
 
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:<br/>
<code>https://transkribus.eu/TrpServer/rest/auth/login</code>
+
<code>https://transkribus.eu/TrpServer/rest/auth/login</code><br/>
 
The method returns an XML with the user profile and the collections that are allowed to be accessed by this user.
 
The method returns an XML with the user profile and the collections that are allowed to be accessed by this user.
  
 
=Collections=
 
=Collections=

Revision as of 07:43, 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.

Collections