GetTasksShortList
Reporting API: Returns the account's tasks with id, name, project, active flag and hierarchy.
| API | Reporting API (short lists) |
| Endpoint | POST https://app{server-number}.timelog.com/{account}/Service.asmx |
| SOAPAction | http://www.timelog.com/ws/tlp/v4_4/GetTasksShortList |
| 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
Filters: project, active status, task type. Tasks of project templates ARE included - unlike GetTasksRaw; filter on ProjectID against GetProjectsShortList. ParentID is omitted when NULL.
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.
0 = no filter. A project-template id is accepted and returns the template's tasks.
Use -1 for no filter. NOTE: GetProjectsShortList's 'all' is -2; -1 there returns nothing.
Task type. 0 = no filter.
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/GetTasksShortList"
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tlp="http://www.timelog.com/ws/tlp/v4_4">
<soap:Body>
<tlp:GetTasksShortList>
<tlp:siteCode>{siteCode}</tlp:siteCode>
<tlp:apiID>{apiID}</tlp:apiID>
<tlp:apiPassword>{apiPassword}</tlp:apiPassword>
<tlp:projectID>0</tlp:projectID>
<tlp:status>-1</tlp:status>
<tlp:taskTypeID>0</tlp:taskTypeID>
</tlp:GetTasksShortList>
</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/GetTasksShortList"' \
--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/GetTasksShortList"'
envelope = """<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tlp="http://www.timelog.com/ws/tlp/v4_4">
<soap:Body>
<tlp:GetTasksShortList>
<tlp:siteCode>{siteCode}</tlp:siteCode>
<tlp:apiID>{apiID}</tlp:apiID>
<tlp:apiPassword>{apiPassword}</tlp:apiPassword>
<tlp:projectID>0</tlp:projectID>
<tlp:status>-1</tlp:status>
<tlp:taskTypeID>0</tlp:taskTypeID>
</tlp:GetTasksShortList>
</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,
)
rows = parse_result(response) # see "Responses and errors"
{…} placeholder with your own value.Response
The result is an XML document inside GetTasksShortListResult: a tlp:Tasks root with one tlp:Task element per record. Check the response format first: the same slot also carries the empty result and errors.
Order: Project ID, then task sort order, then task name, ascending.
One element per record. Fields without a value are left out of the element, so treat every field as optional.
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>
<GetTasksShortListResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
<GetTasksShortListResult>
<tlp:Tasks xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4">
<tlp:Task ID="1001">
<tlp:Name>Example </tlp:Name>
<tlp:ProjectID>12</tlp:ProjectID>
<tlp:Status>1</tlp:Status>
<tlp:ParentID>12</tlp:ParentID>
<tlp:IsParent>0</tlp:IsParent>
</tlp:Task>
</tlp:Tasks>
</GetTasksShortListResult>
</GetTasksShortListResponse>
</soap:Body>
</soap:Envelope>
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>
<GetTasksShortListResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
<GetTasksShortListResult>
<tlp:Tasks resultEmpty="true" xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4"></tlp:Tasks>
</GetTasksShortListResult>
</GetTasksShortListResponse>
</soap:Body>
</soap:Envelope>
Example error
Wrong credentials, or a call over plain HTTP:
HTTP/1.1 401 Unauthorized
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>
<GetTasksShortListResponse xmlns="http://www.timelog.com/ws/tlp/v4_4">
<GetTasksShortListResult>
<tlp:Errors xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4">
<tlp:Error>Access denied. Check siteCode, apiID, apiPassword and SSL settings</tlp:Error>
</tlp:Errors>
</GetTasksShortListResult>
</GetTasksShortListResponse>
</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.