Home Features Tour Pricing
Blog Support Contact us
Call us today on +44 (0)1227 812932 Get your FREE Trial

Controller : Overtime

VERSION: 4.0, DEPRECATED: NO

get-by-id my get submit approve-decline cancel Return to API overview

Calls: {root}/overtime

GETget by id

Route: {root}/v4/overtime/get-by-id

Sample call: {root}/v4/overtime/get-by-id/12345678

Request type User level Requires authentication Response type
URL STAFF Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
overtime_id INT32 REQUIRED 0 2147483647 - -
cURL
curl --location --request GET "{{ROOT}}overtime/get-by-id/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Response object 
[
    {
      "object_name":"overtime_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"user_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"overtime_type_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"overtime_type_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"colour",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"duration",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_requested",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"requested_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_approved",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_date",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"request_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"requested_by_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"requested_by_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_time",
      "type":"[Boolean]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


POSTmy

Route: {root}/v4/overtime/my
Request type User level Requires authentication Response type
BODY STAFF Yes Array()

Params

Name Type Nullable? Required? Min. Max. Nest Custom
date_option CUSTOM REQUIRED 0 3 - custom (0)
this year (1)
next year (2)
last year (3)
start_date DATE REQUIRED FOR OPTION 0 - -
end_date DATE REQUIRED FOR OPTION 0 - -
status_id CUSTOM OPTIONAL - approved and pending (0)
pending only (1)
approved only (100)
overtime_type_ids NESTED OPTIONAL List (Of overtime_type_ids) -

Nested object(s)[]

Object name Param name Type Is Nullable? Required? Min. Max.
overtime_type_ids
overtime_type_id[Int32]FalseREQUIRED02147483647
cURL
curl --location --request POST "{{ROOT}}overtime/my/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"date_option": "0","status_id": "0","overtime_type_ids": [{"overtime_type_id":"234"},{"overtime_type_id":"234"}]}'

Response object 
[
    {
      "object_name":"overtime_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"overtime_type_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"code",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"colour",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"duration",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_requested",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_approved",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"request_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_reminder_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


POSTget

Route: {root}/v4/overtime/get
Request type User level Requires authentication Response type
BODY APPROVER Yes Array()

Params

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM OPTIONAL - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
map_id INT32 OPTIONAL 0 2147483647 - -
user_status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
both (99)
date_option CUSTOM REQUIRED 0 3 - custom (0)
this year (1)
next year (2)
last year (3)
start_date DATE REQUIRED FOR OPTION 0 - -
end_date DATE REQUIRED FOR OPTION 0 - -
status_id CUSTOM OPTIONAL - approved and pending (0)
pending only (1)
approved only (100)
cancelled only (900)
declined only (930)
approved and declined (1000)
cancelled and declined (1010)
overtime_type_ids NESTED OPTIONAL List (Of overtime_type_ids) -

Nested object(s)[]

Object name Param name Type Is Nullable? Required? Min. Max.
overtime_type_ids
overtime_type_id[Int32]FalseREQUIRED02147483647
cURL
curl --location --request POST "{{ROOT}}overtime/get/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"map_type_id": "0","map_id": "123456","user_status_id": "0","date_option": "0","status_id": "0","overtime_type_ids": [{"overtime_type_id":"234"},{"overtime_type_id":"234"}]}'

Response object 
[
    {
      "object_name":"overtime_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"overtime_type_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"code",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"colour",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"duration",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_requested",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_approved",
      "type":"minute(int32)",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"requested_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approved_by_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"request_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_reminder_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


POSTsubmit

Route: {root}/v4/overtime/submit
Request type User level Requires authentication Response type
BODY STAFF Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
user_id [INT32] ✓ OPTIONAL 0 2147483647 - -
overtime_type_id INT32 REQUIRED 0 2147483647 - -
start_date DATETIME REQUIRED - -
duration MINUTE(INT32) REQUIRED 0 2147483647 - -
lieu_time_requested INT32 OPTIONAL 0 2147483647 - -
note STRING OPTIONAL 0 500 - -
admin [BOOLEAN] REQUIRED - -
cURL
curl --location --request POST "{{ROOT}}overtime/submit/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"user_id": "123456","overtime_type_id": "123456","start_date": "20230401T00:00","lieu_time_requested": "123456","note": "sample","admin": false}'

Response object 
[
    {
      "object_name":"overtime_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"pending",
                "value":"1"
            },
            {
                "name":"approved",
                "value":"100"
            },
            {
                "name":"auto approved",
                "value":"110"
            },
            {
                "name":"self approved",
                "value":"120"
            },
            {
                "name":"approved by approver",
                "value":"130"
            },
            {
                "name":"approved by super user",
                "value":"140"
            },
            {
                "name":"paid overtime only",
                "value":"200"
            },
            {
                "name":"cancelled by user pending",
                "value":"900"
            },
            {
                "name":"cancelled by user approved",
                "value":"901"
            },
            {
                "name":"cancelled by approver pending",
                "value":"910"
            },
            {
                "name":"cancelled by approved approved",
                "value":"911"
            },
            {
                "name":"cancelled by super user pending",
                "value":"920"
            },
            {
                "name":"cancelled by super user approved",
                "value":"921"
            },
            {
                "name":"declined by approved",
                "value":"930"
            },
            {
                "name":"declined by auper user",
                "value":"940"
            }]
      "note": 
  },
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


POSTapprove decline

Route: {root}/v4/overtime/approve-decline
Request type User level Requires authentication Response type
BODY APPROVER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
overtime_id [INT32] REQUIRED -2147483648 2147483647 - -
option_id CUSTOM REQUIRED 1 2 - approve (1)
decline (2)
approver_note STRING OPTIONAL 0 500 - -
lieu_time_approved [INT32] REQUIRED -2147483648 2147483647 - -
cURL
curl --location --request POST "{{ROOT}}overtime/approve-decline/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"overtime_id": "123456","option_id": "1","approver_note": "sample","lieu_time_approved": "123456"}'

Response object 
[
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]


POSTcancel

Route: {root}/v4/overtime/cancel
Request type User level Requires authentication Response type
BODY STAFF Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
overtime_id INT32 REQUIRED -2147483648 2147483647 - -
cancellation_note STRING OPTIONAL 0 500 - -
admin BOOLEAN REQUIRED - -
cURL
curl --location --request POST "{{ROOT}}overtime/cancel/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"overtime_id": "123456","cancellation_note": "sample","admin": false}'

Response object 
[
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

INSTANTLY REDUCE TIME SPENT ON LEAVE MANAGEMENT

Get your long FREE trial today!

No obligation and no payment setup required.
Sign up today and get until Monday, 25th November 2024 to try the full service, for Free!
 

Start Your Free Trial

Cookie settings for whosoff.com

We use cookies to improve our website experience, we also use cookies to help us undertand how our website is used, enhance site navigation and analyze site usage and advertising. For more information please refer to our Cookie Policy.

AdvertisingEnables storage related to advertising, for example, advertising campaign.
AnalyticsEnables storage related to analytics, for example, visit duration.
TargetingSets consent for sending user data to Google for online advertising purposes.
MarketingSets consent for personalized advertising.
Manage cookies