GetAllocationsToEmployee

Project management service 1.8: Returns the allocations of one employee on tasks that are active.


Service	Project management 1.8
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc`
SOAPAction	`GetAllocationsToEmployeeRequest`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes

How it works

Lists every allocation of the employee identified by initials whose TASK is active - regardless of whether the allocation itself is completed. Each item carries the allocation's GUID and integer ID, task, planned hours, contract hourly rate ID, dates and the employee header. Allocations whose rate ID is not a contract hourly rate are silently left out. The list is not paged and has no defined order.

Parameters

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

initialsstring

Required

Initials of the employee whose allocations are listed. Matched by the employee look-up.

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: "GetAllocationsToEmployeeRequest"

<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:GetAllocationsToEmployee>
      <pm:initials>{initials}</pm:initials>
      <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:GetAllocationsToEmployee>
  </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: "GetAllocationsToEmployeeRequest"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc"
SOAP_ACTION = '"GetAllocationsToEmployeeRequest"'

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:GetAllocationsToEmployee>
      <pm:initials>{initials}</pm:initials>
      <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:GetAllocationsToEmployee>
  </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.

ReturnAllocation[]

Response<Allocation>: the employee's allocations on active tasks. HourlyRateID is the contract hourly rate ID - no amount. Details.EmployeeHeader repeats the employee. Success with an empty Return when the employee has no allocation on an active task.

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>
    <GetAllocationsToEmployeeResponse xmlns="http://www.timelog.com/api/tlp/v1_8">
      <GetAllocationsToEmployeeResult xmlns:a="http://api.timelog.com"
                                      xmlns:b="http://www.timelog.com/api/tlp/v1_7"
                                      xmlns:c="http://www.timelog.com/api/tlp/v1_5"
                                      xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Allocation>
            <a:Action>Original</a:Action>
            <a:IsCustomFieldsLoaded>false</a:IsCustomFieldsLoaded>
            <a:CustomFields i:nil="true"/>
            <a:IsExternalKeysLoaded>false</a:IsExternalKeysLoaded>
            <a:ExternalKeys i:nil="true"/>
            <b:AllocationID>1001</b:AllocationID>
            <b:ID>3f2504e0-4f89-41d3-9a0c-305000000001</b:ID>
            <b:TaskID>1001</b:TaskID>
            <b:HoursAllocated>0</b:HoursAllocated>
            <b:HourlyRateID>1001</b:HourlyRateID>
            <b:EmployeeID>1001</b:EmployeeID>
            <b:StartDate>2026-10-01T00:00:00</b:StartDate>
            <b:EndDate>2026-10-01T00:00:00</b:EndDate>
            <b:Details>
              <b:EmployeeHeader>
                <c:ID>3f2504e0-4f89-41d3-9a0c-305000000002</c:ID>
                <c:EmployeeID>1001</c:EmployeeID>
                <c:Initials>ABC</c:Initials>
                <c:FirstName>Example first</c:FirstName>
                <c:LastName>Example last</c:LastName>
                <c:EmployeeNo>1001</c:EmployeeNo>
                <c:Fullname>Example</c:Fullname>
              </b:EmployeeHeader>
            </b:Details>
          </b:Allocation>
        </a:Return>
        <a:ReturnTypeDescription>Allocation</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>false</a:IsReturnPaged>
        <a:TotalPageCount>0</a:TotalPageCount>
      </GetAllocationsToEmployeeResult>
    </GetAllocationsToEmployeeResponse>
  </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
Invalid	30015	Unknown employee Initials: '{initials}'.	`initials` is not the initials of an employee.	—
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?