GetDepartmentByNo

Organisation service 1.9: Returns the one department whose number equals departmentNo - active or inactive.


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/GetDepartmentByNo`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes

How it works

Exact-match look-up on the department number. Returns the department as the single item of Return, whether it is active or not.

Parameters

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

departmentNostring

Required

The department number. Exact match. Null matches nothing.

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/GetDepartmentByNo"

<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:GetDepartmentByNo>
      <org:departmentNo>{departmentNo}</org:departmentNo>
      <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:GetDepartmentByNo>
  </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/GetDepartmentByNo"' \
  --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/GetDepartmentByNo"'

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:GetDepartmentByNo>
      <org:departmentNo>{departmentNo}</org:departmentNo>
      <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:GetDepartmentByNo>
  </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 exactly one Department; success message names return type 'Department'. Never - no match is an Invalid envelope.

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>
    <GetDepartmentByNoResponse xmlns="http://www.timelog.com/api/tlp/v1_9">
      <GetDepartmentByNoResult 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>
      </GetDepartmentByNoResult>
    </GetDepartmentByNoResponse>
  </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	0	Unable to find Department object by parameter value: {departmentNo}	No department, or more than one department, has this number - or the data layer failed. ErrorCode 0.	Check ResponseState. For duplicated numbers use GetDepartments and filter by No.

Was this page helpful?