Salary settingsGetAllAbsenceCodes

GetAllAbsenceCodes

Salary service 1.1: Returns every absence code of the account with its payroll mapping.

ServiceSalary 1.1
EndpointPOST https://app{server-number}.timelog.com/{account}/WebServices/Salary/V1_1/SalaryServiceSecure.svc
SOAPActionhttp://www.timelog.com/api/tlp/v1_1/SalaryService/GetAllAbsenceCodes
Content-Typetext/xml; charset=utf-8
AuthenticationA token from GetToken
Changes dataNo
Safe to retryYes

How it works

The account's absence codes: the reasons absence time is registered on. Each entry carries its code and name, the payroll mapping, the salary account it posts to with factor and sign, how absence is entered, and the approval, capacity and visibility flags. REST's absence-code list returns only the caller's salary group. Configuration only: no employee data.

Parameters

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

tokenSecurityToken
Required

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

Request

POST /{account}/WebServices/Salary/V1_1/SalaryServiceSecure.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_1/SalaryService/GetAllAbsenceCodes"

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

ReturnAbsenceCode[]

Response<AbsenceCode>: every absence code, unpaged. No 'Successfully called' message is added; ResponseState Success. ResponseState Success with an empty Return when the account has no absence codes.

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>
    <GetAllAbsenceCodesResponse xmlns="http://www.timelog.com/api/tlp/v1_1">
      <GetAllAbsenceCodesResult xmlns:a="http://api.timelog.com"
                                xmlns:b="http://api.timelog.com/services/salary/1_1"
                                xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:AbsenceCode>
            <b:AbsenceCodeGuid>3f2504e0-4f89-41d3-9a0c-305000000001</b:AbsenceCodeGuid>
            <b:Code>Example</b:Code>
            <b:CodeForSalaryIntegration>Example</b:CodeForSalaryIntegration>
            <b:Description>Example</b:Description>
            <b:FlexPositiveFactor>0</b:FlexPositiveFactor>
            <b:IsActive>true</b:IsActive>
            <b:IsTransferredToSalaryIntegration>false</b:IsTransferredToSalaryIntegration>
            <b:Name>Example </b:Name>
            <b:SalaryAccountFactor>0</b:SalaryAccountFactor>
            <b:SalaryAccountFactorEffect>Substract</b:SalaryAccountFactorEffect>
            <b:SalaryAccountID>1001</b:SalaryAccountID>
            <b:TimeTrackingFormat>Hours</b:TimeTrackingFormat>
            <b:AbsenceCodeID>1001</b:AbsenceCodeID>
            <b:AbsenceCodeTypeID>1001</b:AbsenceCodeTypeID>
            <b:DeductCapacity>false</b:DeductCapacity>
            <b:IsPublicVisible>false</b:IsPublicVisible>
            <b:RequireApproval>false</b:RequireApproval>
          </b:AbsenceCode>
        </a:Return>
        <a:ReturnTypeDescription>AbsenceCode</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>
      </GetAllAbsenceCodesResult>
    </GetAllAbsenceCodesResponse>
  </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.

This operation has no errors of its own beyond the shared ones.