ValidateCredentials
Reporting API: Tells whether a siteCode / apiID / apiPassword triple would be accepted by the data operations - true or false, nothing else.
| API | Reporting API (credentials) |
| Endpoint | POST https://app{server-number}.timelog.com/{account}/Service.asmx |
| SOAPAction | http://www.timelog.com/ws/tlp/v4_4/ValidateCredentials |
| Content-Type | text/xml; charset=utf-8 |
| Authentication | siteCode, apiID and apiPassword as the first three parameters. See Authentication |
| Changes data | No. Safe to retry. |
| Paging | No: the whole result comes in one response. Narrow it with the filters. |
How it works
Runs exactly the credential check every Reporting data operation runs first and returns its Boolean.
Parameters
Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.
Your account's site code, from the Reporting API settings.
The Reporting API ID, from the Reporting API settings.
The Reporting API password, from the Reporting API settings.
Request
POST /{account}/Service.asmx HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.timelog.com/ws/tlp/v4_4/ValidateCredentials"
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tlp="http://www.timelog.com/ws/tlp/v4_4">
<soap:Body>
<tlp:ValidateCredentials>
<tlp:siteCode>{siteCode}</tlp:siteCode>
<tlp:apiID>{apiID}</tlp:apiID>
<tlp:apiPassword>{apiPassword}</tlp:apiPassword>
</tlp:ValidateCredentials>
</soap:Body>
</soap:Envelope>
curl -X POST "https://app{server-number}.timelog.com/{account}/Service.asmx" \
-H "Content-Type: text/xml; charset=utf-8" \
-H 'SOAPAction: "http://www.timelog.com/ws/tlp/v4_4/ValidateCredentials"' \
--data-binary @request.xml
import requests
URL = "https://app{server-number}.timelog.com/{account}/Service.asmx"
SOAP_ACTION = '"http://www.timelog.com/ws/tlp/v4_4/ValidateCredentials"'
envelope = """<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tlp="http://www.timelog.com/ws/tlp/v4_4">
<soap:Body>
<tlp:ValidateCredentials>
<tlp:siteCode>{siteCode}</tlp:siteCode>
<tlp:apiID>{apiID}</tlp:apiID>
<tlp:apiPassword>{apiPassword}</tlp:apiPassword>
</tlp:ValidateCredentials>
</soap:Body>
</soap:Envelope>"""
response = requests.post(
URL,
data=envelope.encode("utf-8"),
headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
timeout=300,
)
valid = parse_result(response) == "true" # see "Responses and errors"
{…} placeholder with your own value.Response
The result is ValidateCredentialsResult: true or false. This method always answers with HTTP 200, also when the credentials are wrong.
Always HTTP 200.
Example response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
<?xml version="1.0" encoding="utf-8"?>
<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>
<ValidateCredentialsResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
<ValidateCredentialsResult>true</ValidateCredentialsResult>
</ValidateCredentialsResponse>
</soap:Body>
</soap:Envelope>
Example error
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
<?xml version="1.0" encoding="utf-8"?>
<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>
<ValidateCredentialsResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
<ValidateCredentialsResult>false</ValidateCredentialsResult>
</ValidateCredentialsResponse>
</soap:Body>
</soap:Envelope>
Errors
The errors every method can return (access denied, operation failed, invalid request) are listed once in Responses and errors.
This method has no errors of its own beyond the shared ones.