Back to Absence Code

GET Method Details for GetByStatus.

Get a list of absence code by status (all, inactive, active)

Definition

https://app[x].timelog.com/[account name]/api/v{version}/absence-code/{status}

Parameters

• status integer An enum of ActiveStatus, can be all(-1), inactive(0) or active(1)
• version string The requested API version

Returns

• [200] A list of absence code
  • Model
  • Example Value
  • AbsenceCode string Gets or sets the absence code.
  • AbsenceCodeID integer Gets or sets the absence code identifier.
  • AbsenceCodeTypeID integer Gets or sets the absence code type identifier.
  • DeductCapacity boolean Gets or sets a value indicating whether [deduct capacity].
  • Description string Gets or sets the description.
  • FlexPositiveFactor number Gets or sets the flex positive factor.
  • ID string Gets or sets the identifier.
  • IsActive boolean Gets or sets a value indicating whether this instance is active.
  • IsPublicVisible boolean Gets or sets a value indicating whether this instance is public visible.
  • Name string Gets or sets the name.
  • RequireApproval boolean Gets or sets a value indicating whether [require approval].
  • SalaryAccountFactor number Gets or sets the salary account factor.
  • SalaryAccountFactorEffect integer Gets or sets the salary account factor effect.
  • SalaryAccountID integer Gets or sets the salary account identifier.
  • TimeTrackingFormat integer Gets or sets the time tracking format.

  {
    "AbsenceCode": "",
    "AbsenceCodeID": 0,
    "AbsenceCodeTypeID": 0,
    "DeductCapacity": false,
    "Description": "",
    "FlexPositiveFactor": 0.0,
    "ID": "00000000-0000-0000-0000-000000000000",
    "IsActive": false,
    "IsPublicVisible": false,
    "Name": "",
    "RequireApproval": false,
    "SalaryAccountFactor": 0.0,
    "SalaryAccountFactorEffect": 0,
    "SalaryAccountID": 0,
    "TimeTrackingFormat": 0
  }

• [400] Status specified is invalid
  • Model
  • Example Value
  • Code integer Gets the code.
  • Details array Gets the details.
  • Message string Gets the message.
  • Parameters string Gets the parameters.
  • Url string Gets the URL.

  {
    "Code": 0,
    "Details": "",
    "Message": "",
    "Parameters": "",
    "Url": ""
  }

• [401] Invalid authentication token
• [500] Request to GetByStatus has failed
  • Model
  • Example Value
  • Code integer Gets the code.
  • Details array Gets the details.
  • Message string Gets the message.
  • Parameters string Gets the parameters.
  • Url string Gets the URL.

  {
    "Code": 0,
    "Details": "",
    "Message": "",
    "Parameters": "",
    "Url": ""
  }