20.03.28 Working Days

Root Folder > UNItekTIME Documentation > 20 TimeLive API > 20.03 API

20.03.28 Working Days

The Working Day Object

AccountWorkingDayTypeYesStringName of Working Days25
HoursPerDayYesIntegerHours Per Day of Working Days2
MinimumHoursPerDayYesIntegerMinimum Hours Per Day of Working Days2
MaximumHoursPerDayYesIntegerMaximum Hours Per Day of Working Days2
MinimumHoursPerWeekYesIntegerMinimum Hours Per Week of Working Days2
MaximumHoursPerWeekYesIntegerMaximum Hours Per Week of Working Days2
WeekStartsOnYesStringWeek Start day of Working Days9
WorkingDaysYesStringWorking Days of Working Days [ coma seperated values (e.g mon,tue,wed) ]70
AccountWorkingDayTypeIdNoGuidId of Working Days32
IsDisabledNoBooleanDisable Status of Working Days1
EnableBalanceValidationForTimeOffNoBooleanBalance Validation For TimeOff Status of Working Days1
ShowClockStartEndEmployeeNoBooleanShow Clock Start / End for Employees of Working Days1
AccountTimesheetPeriodTypeIdNoGuidTimesheet PeriodType Id of Working Days32
TimesheetOverdueAfterDaysNoIntegerTimesheet Overdue After Days of Working Days2
MinimumPercentagePerDayNoIntegerMinimum Percentage Per Day of Working Days3
MaximumPercentagePerDayNoIntegerMaximum Percentage Per Day of Working Days3
MinimumPercentagePerWeekNoIntegerMinimum Percentage Per Week of Working Days3
MaximumPercentagePerWeekNoIntegerMaximum Percentage Per Week of Working Days3
LockPreviousTimesheetPeriodsNoIntegerLock Number of Previous Timesheet Periods of Working Days2
LockFutureTimsheetPeriodsNoIntegerLock Number of Future Timsheet Periods of Working Days2
LockPreviousNextMonthTimesheetOnNoIntegerDisable edit Timesheet on Specific date of the month of Working Days2
LockAllPeriodExceptPreviousNoIntegerLock All Timesheet Periods Except Previous of Working Days2
LockAllPeriodExceptNextNoIntegerLock All Timesheet Periods Except Next Period of Working Days2
LockAllPreviousTimesheetsNoBooleanAllow Timesheet Entry in previous Period of Working Days1
LockAllFutureTimesheetsNoBooleanAllow Timesheet Entry in Future Periods of Working Days1

List All Working Days

Returns a list of your all Working Days in your UNItekTIME account.
GET /API/WorkingDays

Example Request

curl "https://demo.unitektime.com/api/WorkingDays" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
     {
        "AccountWorkingDayTypeId": "00000000-0000-0000-0000-000000000000",
        "AccountId": 7606,
        "AccountWorkingDayType": "Standard",
        "HoursPerDay": 8,
        "CreatedByEmployeeId": 0,
        "CreatedOn": "2017-11-01T10:55:31.523+00:00",
        "ModifiedByEmployeeId": 0,
        "ModifiedOn": "2017-11-01T10:55:31.523+00:00",
        "MasterWorkingDayTypeId": "00000000-0000-0000-0000-000000000000",
        "MinimumHoursPerDay": 0,
        "MaximumHoursPerDay": 24,
        "MinimumHoursPerWeek": 0,
        "MaximumHoursPerWeek": 60,
        "AccountTimesheetPeriodTypeId": "00000000-0000-0000-0000-000000000000",
        "TimesheetOverdueAfterDays": null,
        "MinimumPercentagePerDay": 0,
        "MaximumPercentagePerDay": 100,
        "MinimumPercentagePerWeek": 0,
        "MaximumPercentagePerWeek": 500,
        "LockPreviousTimesheetPeriods": null,
        "LockFutureTimsheetPeriods": null,
        "LockPreviousNextMonthTimesheetOn": null,
        "LockAllPeriodExceptPrevious": null,
        "LockAllPeriodExceptNext": null,
        "WeekStartsOn": "Monday",
        "WorkingDays": "Monday , Tuesday , Wednesday , Friday , Saturday",
        "IsDisabled": "No",
        "LockAllPreviousTimesheets": null,
        "LockAllFutureTimesheets": null,
        "EnableBalanceValidationForTimeOff": "Yes",
        "ShowClockStartEndEmployee": null
    },
    {
        "AccountWorkingDayTypeId": "00000000-0000-0000-0000-000000000000",
        "AccountId": 7606,
        "AccountWorkingDayType": "demo",
        "HoursPerDay": 8,
        "CreatedByEmployeeId": 17739,
        "CreatedOn": "2018-06-01T16:27:06.043+00:00",
        "ModifiedByEmployeeId": 17739,
        "ModifiedOn": "2018-06-01T16:31:15.98+00:00",
        "MasterWorkingDayTypeId": null,
        "MinimumHoursPerDay": 5,
        "MaximumHoursPerDay": 8,
        "MinimumHoursPerWeek": 25,
        "MaximumHoursPerWeek": 40,
        "AccountTimesheetPeriodTypeId": "00000000-0000-0000-0000-000000000000",
        "TimesheetOverdueAfterDays": 0,
        "MinimumPercentagePerDay": 0,
        "MaximumPercentagePerDay": 100,
        "MinimumPercentagePerWeek": 0,
        "MaximumPercentagePerWeek": 500,
        "LockPreviousTimesheetPeriods": 0,
        "LockFutureTimsheetPeriods": 0,
        "LockPreviousNextMonthTimesheetOn": 0,
        "LockAllPeriodExceptPrevious": 0,
        "LockAllPeriodExceptNext": 0,
        "WeekStartsOn": "Monday",
        "WorkingDays": "Monday , Tuesday , Wednesday",
        "IsDisabled": "No",
        "LockAllPreviousTimesheets": "No",
        "LockAllFutureTimesheets": "No",
        "EnableBalanceValidationForTimeOff": "Yes",
        "ShowClockStartEndEmployee": "No"
    }
]

Retrieve a Working Day

Retrieves the Working Day with the given ID. Returns a Working Day object and a 200 OK response code if a valid identifier was provided.
GET /API/WorkingDays/{TimeOffTypes_ID}

Example Request

curl "https://demo.unitektime.com/api/WorkingDays/00000000-0000-0000-0000-000000000000" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
     {
        "AccountWorkingDayTypeId": "00000000-0000-0000-0000-000000000000",
        "AccountId": 7606,
        "AccountWorkingDayType": "Standard",
        "HoursPerDay": 8,
        "CreatedByEmployeeId": 0,
        "CreatedOn": "2017-11-01T10:55:31.523+00:00",
        "ModifiedByEmployeeId": 0,
        "ModifiedOn": "2017-11-01T10:55:31.523+00:00",
        "MasterWorkingDayTypeId": "00000000-0000-0000-0000-000000000000",
        "MinimumHoursPerDay": 0,
        "MaximumHoursPerDay": 24,
        "MinimumHoursPerWeek": 0,
        "MaximumHoursPerWeek": 60,
        "AccountTimesheetPeriodTypeId": "00000000-0000-0000-0000-000000000000",
        "TimesheetOverdueAfterDays": null,
        "MinimumPercentagePerDay": 0,
        "MaximumPercentagePerDay": 100,
        "MinimumPercentagePerWeek": 0,
        "MaximumPercentagePerWeek": 500,
        "LockPreviousTimesheetPeriods": null,
        "LockFutureTimsheetPeriods": null,
        "LockPreviousNextMonthTimesheetOn": null,
        "LockAllPeriodExceptPrevious": null,
        "LockAllPeriodExceptNext": null,
        "WeekStartsOn": "Monday",
        "WorkingDays": "Monday , Tuesday , Wednesday , Friday , Saturday",
        "IsDisabled": "No",
        "LockAllPreviousTimesheets": null,
        "LockAllFutureTimesheets": null,
        "EnableBalanceValidationForTimeOff": "Yes",
        "ShowClockStartEndEmployee": null
    }
]

Create a Working Day

Creates a Working Day in your UNItekTIME account and returns the Response Message.
POST /API/WorkingDays
Object PropertyRequiredObject TypeDescriptionMax Character Length
AccountWorkingDayTypeYesStringName of Working Days25
HoursPerDayYesIntegerHours Per Day of Working Days2
MinimumHoursPerDayYesIntegerMinimum Hours Per Day of Working Days2
MaximumHoursPerDayYesIntegerMaximum Hours Per Day of Working Days2
MinimumHoursPerWeekYesIntegerMinimum Hours Per Week of Working Days2
MaximumHoursPerWeekYesIntegerMaximum Hours Per Week of Working Days2
WeekStartsOnYesStringWeek Start day of Working Days9
WorkingDaysYesStringWorking Days of Working Days [ coma seperated values (e.g mon,tue,wed) ]70

Example Request

curl "https://demo.unitektime.com/api/Working Days" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'WeekStartsOn':'Monday','WorkingDays':'mon,tue','AccountWorkingDayType':'Demo','MinimumHoursPerDay':1,'MaximumHoursPerDay':5,'MinimumHoursPerWeek':2,'MaximumHoursPerWeek':10,'HoursPerDay':2}"

Example Response

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "message": "WorkingDayType Added Successfully"
    }
]

Update a Working Day

Update a Working Day in your UNItekTIME account and returns the Response Message.
POST /API/WorkingDays/{Working Days_ID}

Example Request

curl "https://demo.unitektime.com/api/WorkingDays/00000000-0000-0000-0000-000000000000" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'IsDisabled': true}"

Example Response

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "message": "WorkingDayType Updated Successfully"
    }
]

Delete a Working Day

Delete a Working Day. Returns a 200 OK response code if the call succeeded.
DELETE /API/WorkingDays/{WorkingDays_ID}

Example Request

curl "https://demo.unitektime.com/api/WorkingDays/00000000-0000-0000-0000-000000000000" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X DELETE \
      -H "Content-Type: application/json"

Example Response

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "message": "WorkingDayType Deleted Successfully"
    }
]
Article ID: 132, , Modified: 3/24/2021 at 3:07 AM

Share this article