GetWorkPagedWithExternalIds

Project management service 1.8: Returns time registrations at one approval level on projects linked to a named external system, with that system's keys for customer, project and task, a page at a time.


Service	Project management 1.8
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc`
SOAPAction	`http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetWorkPagedWithExternalIds`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes
Paging	Yes, up to 500 per page

How it works

Like GetWorkPaged, restricted to registrations whose PROJECT has an external-system mapping for systemName and whose ApprovedStatus equals approvalLevel exactly. Absence registrations are never returned.

Parameters

Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.

systemNamestring

Required

Name of the external system.

approvalLevelinteger

Required

Exact approval level to return.

initialsstring

Optional. Default empty = all employees. Initials of one employee, or empty for all.

startDatedateTime

Required

First work date.

endDatedateTime

Required

Last work date.

pageinteger

Required

pageSizeinteger

Required

tokenSecurityToken

Required

The token from GetToken: Initials, Expires and Hash, sent back unchanged.

Request

POST /{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetWorkPagedWithExternalIds"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:pm="http://www.timelog.com/api/tlp/v1_8"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <pm:GetWorkPagedWithExternalIds>
      <pm:systemName>{systemName}</pm:systemName>
      <pm:approvalLevel>{approvalLevel}</pm:approvalLevel>
      <pm:initials>{initials}</pm:initials>
      <pm:startDate>{startDate}</pm:startDate>
      <pm:endDate>{endDate}</pm:endDate>
      <pm:page>1</pm:page>
      <pm:pageSize>100</pm:pageSize>
      <pm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </pm:token>
    </pm:GetWorkPagedWithExternalIds>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetWorkPagedWithExternalIds"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc"
SOAP_ACTION = '"http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetWorkPagedWithExternalIds"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:pm="http://www.timelog.com/api/tlp/v1_8"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <pm:GetWorkPagedWithExternalIds>
      <pm:systemName>{systemName}</pm:systemName>
      <pm:approvalLevel>{approvalLevel}</pm:approvalLevel>
      <pm:initials>{initials}</pm:initials>
      <pm:startDate>{startDate}</pm:startDate>
      <pm:endDate>{endDate}</pm:endDate>
      <pm:page>1</pm:page>
      <pm:pageSize>100</pm:pageSize>
      <pm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </pm:token>
    </pm:GetWorkPagedWithExternalIds>
  </soapenv:Body>
</soapenv:Envelope>"""

response = requests.post(
    URL,
    data=envelope.encode("utf-8"),
    headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
    timeout=60,
)
result = parse_result(response)  # see "Responses and errors"

Replace every {…} placeholder with your own value.

Response

The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.

ResponseStatestring

Required

Success, Invalid or Error.

ErrorCodeinteger

0 on success, otherwise the error code. See Errors.

TotalPageCountinteger

Number of pages for the whole result with your pageSize. Keep calling with page + 1 until you have read them all.

ReturnWorkUnitFlatExternal[]

Response<WorkUnitFlatExternal>: one page; IsReturnPaged = true, TotalPageCount = -1; 'Successfully called' message. ResponseState Success, empty Return - also for an unknown systemName or an approvalLevel other than 0 / 10 / 20 / 30.

Example response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetWorkPagedWithExternalIdsResponse xmlns="http://www.timelog.com/api/tlp/v1_8">
      <GetWorkPagedWithExternalIdsResult xmlns:a="http://api.timelog.com"
                                         xmlns:b="http://www.timelog.com/api/tlp/v1_7"
                                         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:WorkUnitFlatExternal>
            <b:Action>Example</b:Action>
            <b:ActionDate>2026-10-01T00:00:00</b:ActionDate>
            <b:ApprovedStatus>0</b:ApprovedStatus>
            <b:CustomerExternalId>Example</b:CustomerExternalId>
            <b:CustomerGuid>3f2504e0-4f89-41d3-9a0c-305000000001</b:CustomerGuid>
            <b:CustomerName>Example customer</b:CustomerName>
            <b:CustomerNo>1001</b:CustomerNo>
            <b:Date>2026-10-01T00:00:00</b:Date>
            <b:EmployeeDepartmentGuid>3f2504e0-4f89-41d3-9a0c-305000000002</b:EmployeeDepartmentGuid>
            <b:EmployeeDepartmentName>Example employee department</b:EmployeeDepartmentName>
            <b:EmployeeDepartmentNo>1001</b:EmployeeDepartmentNo>
            <b:EmployeeGuid>3f2504e0-4f89-41d3-9a0c-305000000003</b:EmployeeGuid>
            <b:EmployeeInitials>Example</b:EmployeeInitials>
            <b:EmployeeInternalId>Example</b:EmployeeInternalId>
            <b:Hours>0</b:Hours>
            <b:ProjectCategoryName>Example project category</b:ProjectCategoryName>
            <b:ProjectDepartmentGuid>3f2504e0-4f89-41d3-9a0c-305000000004</b:ProjectDepartmentGuid>
            <b:ProjectDepartmentName>Example project department</b:ProjectDepartmentName>
            <b:ProjectDepartmentNo>1001</b:ProjectDepartmentNo>
            <b:ProjectExternalId>Example</b:ProjectExternalId>
            <b:ProjectGuid>3f2504e0-4f89-41d3-9a0c-305000000005</b:ProjectGuid>
            <b:ProjectName>Example project</b:ProjectName>
            <b:ProjectNo>1001</b:ProjectNo>
            <b:ProjectStatusName>Example project status</b:ProjectStatusName>
            <b:ProjectTypeName>Example project type</b:ProjectTypeName>
            <b:SalaryCode>Example</b:SalaryCode>
            <b:SalaryCodeGuid>3f2504e0-4f89-41d3-9a0c-305000000006</b:SalaryCodeGuid>
            <b:SalaryCodeName>Example salary code</b:SalaryCodeName>
            <b:TaskExternalId>Example</b:TaskExternalId>
            <b:TaskGuid>3f2504e0-4f89-41d3-9a0c-305000000007</b:TaskGuid>
            <b:TaskName>Example task</b:TaskName>
            <b:TaskNameChain>Example</b:TaskNameChain>
            <b:TaskNo>1001</b:TaskNo>
            <b:TaskNoChain>Example</b:TaskNoChain>
            <b:TaskParentGuid>3f2504e0-4f89-41d3-9a0c-305000000008</b:TaskParentGuid>
            <b:TaskTypeName>Example task type</b:TaskTypeName>
            <b:TaskWBS>Example</b:TaskWBS>
            <b:WorkUnitGuid>3f2504e0-4f89-41d3-9a0c-305000000009</b:WorkUnitGuid>
          </b:WorkUnitFlatExternal>
        </a:Return>
        <a:ReturnTypeDescription>WorkUnitFlatExternal</a:ReturnTypeDescription>
        <a:Request>…</a:Request>
        <a:ResponseState>Success</a:ResponseState>
        <a:Messages>
          <a:APIMessage>
            <a:Message>Duration of call was 0,0421337 sec.</a:Message>
            <a:Severity>Message</a:Severity>
            <a:ErrorCode>0</a:ErrorCode>
          </a:APIMessage>
        </a:Messages>
        <a:ErrorCode>0</a:ErrorCode>
        <a:IsReturnPaged>true</a:IsReturnPaged>
        <a:TotalPageCount>1</a:TotalPageCount>
      </GetWorkPagedWithExternalIdsResult>
    </GetWorkPagedWithExternalIdsResponse>
  </s:Body>
</s:Envelope>

Illustrative example: built from the service description (WSDL) in the same format as a real response, with made-up values. The Request block is shortened.

Errors

All errors come back with HTTP 200: check ResponseState, ErrorCode and Messages. The errors every operation can return (expired or invalid token, API not enabled, HTTPS required, general errors) are listed once in Responses and errors.

Errors specific to this operation:

ResponseState	ErrorCode	Message	What it means	What to do
Error	40001	Error during call on TimeLog.API, Message 'The current user is not allowed to fetch registrations from other users'	Return is empty, IsReturnPaged true, TotalPageCount -1.	—
Invalid	40004	V1_{n} is deprecated. Please upgrade to V1_{m} or later.	Nothing is read or written and the token is NOT checked.	Call the same operation on the current version.

Was this page helpful?