DeactivateDepartment

Organisation service 1.9: Sets a department inactive - refused while it has active employees or active sub-departments.


Service	Organisation 1.9
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/Organisation/V1_9/OrganisationServiceSecure.svc`
SOAPAction	`http://www.timelog.com/api/tlp/v1_9/OrganisationService/DeactivateDepartment`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	Yes
Safe to retry	Yes

How it works

Marks the department inactive. It then disappears from GetDepartments; it is still returned by GetDepartmentByNo and can be reactivated with UpdateDepartment. Nothing happens to its members: the call is REFUSED while any ACTIVE employee belongs to the department or to any department below it, or while it has an ACTIVE direct sub-department - move or deactivate those first. Inactive employees, projects and customers that reference the department do not block it and keep their reference. The refusal does not say which rule failed. Deactivating an already inactive department succeeds without doing anything.

Parameters

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

departmentGuidguid

Required

GUID of the department. Unknown -> 'The department could not be found'.

tokenSecurityToken

Required

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

Request

POST /{account}/WebServices/Organisation/V1_9/OrganisationServiceSecure.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_9/OrganisationService/DeactivateDepartment"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:org="http://www.timelog.com/api/tlp/v1_9"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <org:DeactivateDepartment>
      <org:departmentGuid>{departmentGuid}</org:departmentGuid>
      <org:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </org:token>
    </org:DeactivateDepartment>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/Organisation/V1_9/OrganisationServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://www.timelog.com/api/tlp/v1_9/OrganisationService/DeactivateDepartment"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/Organisation/V1_9/OrganisationServiceSecure.svc"
SOAP_ACTION = '"http://www.timelog.com/api/tlp/v1_9/OrganisationService/DeactivateDepartment"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:org="http://www.timelog.com/api/tlp/v1_9"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <org:DeactivateDepartment>
      <org:departmentGuid>{departmentGuid}</org:departmentGuid>
      <org:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </org:token>
    </org:DeactivateDepartment>
  </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.

ReturnDepartment[]

Response<Department>: Return holds the department. Success message names return type 'Department'. Never - failure is an Error envelope with an empty Return.

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>
    <DeactivateDepartmentResponse xmlns="http://www.timelog.com/api/tlp/v1_9">
      <DeactivateDepartmentResult xmlns:a="http://api.timelog.com"
                                  xmlns:b="http://www.timelog.com/api/tlp/v1_9"
                                  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Department>
            <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:ID>3f2504e0-4f89-41d3-9a0c-305000000001</b:ID>
            <b:Name>Example </b:Name>
            <b:No>1001</b:No>
            <b:ParentDepartmentGuid>3f2504e0-4f89-41d3-9a0c-305000000002</b:ParentDepartmentGuid>
            <b:DepartmentManagerGuid>3f2504e0-4f89-41d3-9a0c-305000000003</b:DepartmentManagerGuid>
            <b:DepartmentID>1001</b:DepartmentID>
          </b:Department>
        </a:Return>
        <a:ReturnTypeDescription>Department</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>
      </DeactivateDepartmentResult>
    </DeactivateDepartmentResponse>
  </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 'Your site doesn't have departments enabled'	The department reads are not gated.	Enable departments on the account, or do not maintain departments through the API.
Error	40001	Error during call on TimeLog.API, Message 'Unable to retrieve department from … with DepartmentGUID {guid}'	No department with this GUID - message 'The department could not be found'.	Take the GUID from GetDepartments or GetDepartmentByNo.
Error	40001	Error during call on TimeLog.API, Message 'The department cannot be deactivated'	An active employee in the department or its sub-tree, or an active direct sub-department.	Move or deactivate the employees, deactivate the sub-departments bottom-up, then retry.

Was this page helpful?