Login

Build 1501 on 14/Nov/2017  This topic last edited on: 22/Mar/2016, at 17:02

Description

Login to the system. This command returns a ‘ticket’ that is required for every REST call to access the database.

Parameters (* denotes an optional parameter)

Name*

Optional string containing the name of the user logging-in. If omitted, the Windows user is used.

Pwd*

Optional password for the user logging-in. Used only if a user name has been specified.

AppName*

Optional name identifying the application the user is using.

Language*

Optional string identifying the language (e.g. 'en-US', 'it', etc.) that should be used by the system for this login.

Example

http://server/tark4/do.ashx?cmd=login&name=administrator&pwd=myadminpwd

This REST call returns an xml file like the one below. The "ticket" returned must be used in successive calls to access the database.

<?xml version="1.0" encoding="utf-8" ?>

<result

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns="http://www.teradp.com/schemas/GN4/1/Results.xsd">

 <loginResult

  ticket="d6721dd0-027c-49a1-aae9-134c83c248a3"

  userId="4" userName="administrator"

  userFullName="Tark4 Administrator" userEMail="">

 </loginResult>

</result>

 

In this example, successive REST calls should be constructed using the ticket number, e.g.;

http://server/GNPortal/do.ashx?&cmd=objslist&type=pubDest&ticket=d6721dd0-027c-49a1-aae9-134c83c248a3

See also

LoginData, Logout