Serena Agile Web Services API → Authentication → Logon
This method is required to create an authenticated Web services session. It must be called before any other webservice methods can be used. This method returns a token which is supplied to all of the other methods.
The parameters for the Logon method are:
Parameter | Datatype | Description |
---|---|---|
username | string | The user name of the user who is logging in. |
password | string | The password associated with the username. |
dbtitle | string | The connection name of the database to connect to. |
XML request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:agil="http://serena.com/Agile"> <soapenv:Header/> <soapenv:Body> <agil:Logon> <agil:username>user@example.com</agil:username> <agil:password>p@$$w0rD</agil:password> <agil:dbtitle>AGILE_database_name</agil:dbtitle> </agil:Logon> </soapenv:Body> </soapenv:Envelope>
XML response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <LogonResponse xmlns="http://serena.com/Agile"> <LogonResult>5092995f-f90b-4743-a0f4-1c74de64d2caAGILE_database_name</LogonResult> </LogonResponse> </soap:Body> </soap:Envelope>