RenewTicket API

Validates the user's credentials and either renews an existing authentication ticket or issues a new one. This is useful for long-running client applications that need to keep a session alive without requiring a full login cycle.

The caller always supplies their credentials (UID / PWD). If a valid OldTicket is provided, it is renewed and its expiration window is reset. If the old ticket has already expired, the credentials are used to authenticate normally and a fresh ticket is returned.

No prior authentication ticket is required — this method acts as a combined validate-and-refresh login.

Endpoint

/srv.asmx/RenewTicket

Methods

Parameters

Parameter Type Required Description
UID string Yes The user's login name. Always validated against the database regardless of ticket status.
PWD string Yes The user's password. Always validated regardless of ticket status.
Lang string No Language code for the session (e.g. en, de, fr, tr). If omitted or empty, the user's preferred language from their profile is used.
OldTicket string No The existing ticket GUID to renew. If omitted or empty, the server checks the ticket HTTP cookie. If no cookie is present either, a completely fresh session is created. Must be a valid GUID string if supplied — an invalid format returns an error immediately.

Response

Success Response

<root success="true"
      ticket="3f2a1b4c-5d6e-7f8a-9b0c-1d2e3f4a5b6c"
      userid="42"
      username="jsmith"
      firstName="John"
      lastName="Smith"
      fullname="John Smith"
      email="jsmith@example.com"
      expireOn="2026-03-20T14:35:00Z"
      isAuthenticated="True" />

Response Attributes

Attribute Type Description
success boolean true on success
ticket GUID string The renewed or newly issued authentication ticket
userid integer Internal numeric user ID
username string The user's login name
firstName string User's first name
lastName string User's last name
fullname string User's full display name
email string User's email address
expireOn datetime (UTC) New ticket expiration timestamp (30-day sliding window from this call)
isAuthenticated boolean string Whether the session is authenticated (True/False)

Error Response

<root success="false" error="[ErrorCode] Error message" />

Required Permissions

Example

Request (GET) — renewing an existing ticket

GET /srv.asmx/RenewTicket?UID=jsmith&PWD=Secret123!&Lang=en&OldTicket=3f2a1b4c-5d6e-7f8a-9b0c-1d2e3f4a5b6c HTTP/1.1
Host: server.example.com

Request (GET) — fresh login (no old ticket)

GET /srv.asmx/RenewTicket?UID=jsmith&PWD=Secret123!&Lang=en HTTP/1.1
Host: server.example.com

Request (POST)

POST /srv.asmx/RenewTicket HTTP/1.1
Content-Type: application/x-www-form-urlencoded

UID=jsmith&PWD=Secret123!&Lang=en&OldTicket=3f2a1b4c-5d6e-7f8a-9b0c-1d2e3f4a5b6c

Request (SOAP 1.1)

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/RenewTicket"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RenewTicket xmlns="http://tempuri.org/">
      <UID>jsmith</UID>
      <PWD>Secret123!</PWD>
      <Lang>en</Lang>
      <OldTicket>3f2a1b4c-5d6e-7f8a-9b0c-1d2e3f4a5b6c</OldTicket>
    </RenewTicket>
  </soap:Body>
</soap:Envelope>

Notes

Error Codes

Error Description
invalid ticket format OldTicket was supplied but is not a valid GUID string
[900] Authentication failed The UID or PWD is incorrect, or the account is disabled or does not exist
[902] Ticket generation are not allowed for this user. The account is not permitted to generate API tickets