Home Features Pricing
Case studies Blog Support Contact us Refer a Business
Call us today on +44 (0)1227 812932 Get your FREE Trial

Controller : Overtime Type

VERSION: 4.0, DEPRECATED: NO

create retrieve retrieve-by-id retrieve-for-user update del Return to API overview

Calls: {root}/overtime type


POSTcreate

Route: {root}/v4/overtime-type/create
Request type User level Requires authentication Response type
BODY SUPER USER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
name STRING REQUIRED 0 50 - -
code STRING REQUIRED 0 2 - -
colour STRING REQUIRED 0 7 - -
requires_approval [BOOLEAN] REQUIRED - -
note_required [BOOLEAN] REQUIRED - -
email_request_id CUSTOM REQUIRED 0 4 - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_approve_id CUSTOM REQUIRED 0 4 - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_cancel_id CUSTOM REQUIRED 0 4 - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
lieu_time [BOOLEAN] REQUIRED - -
status_id CUSTOM REQUIRED 0 1 - disabled (0)
active (1)
available_to_id CUSTOM REQUIRED 100 310 - staff (100)
approver (200)
super user (300)
super user with staff hub (310)
message STRING OPTIONAL 0 500 - -
cURL
curl --location --request POST "{{ROOT}}overtime-type/create/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"name": "sample","code": "sample","colour": "sample","requires_approval": false,"note_required": false,"email_request_id": "0","email_approve_id": "0","email_cancel_id": "0","lieu_time": false,"status_id": "0","available_to_id": "100","message": "sample"}'

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



POSTretrieve

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

Params

Name Type Nullable? Required? Min. Max. Nest Custom
status_id CUSTOM REQUIRED 0 99 - disabled (0)
active (1)
both (99)
cURL
curl --location --request POST "{{ROOT}}overtime-type/retrieve/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"status_id": "0"}'

Response object 
[
    {
      "object_name":"overtime_type_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"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":"requires_approval",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"note_required",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_request_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_approve_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_cancel_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"lieu_time",
      "type":"Boolean",
      "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":"available_to_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  }
]



GETretrieve by id

Route: {root}/v4/overtime-type/retrieve-by-id

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

Request type User level Requires authentication Response type
URL STAFF Yes Array()

Params

Name Type Nullable? Required? Min. Max. Nest Custom
overtime_type_id INT32 REQUIRED 0 2147483647 - -
cURL
curl --location --request GET "{{ROOT}}overtime-type/retrieve-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_type_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"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":"requires_approval",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"note_required",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_request_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_approve_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"email_cancel_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"staff approver notifier",
                "value":"1"
            },
            {
                "name":"staff only",
                "value":"2"
            },
            {
                "name":"staff approver",
                "value":"3"
            },
            {
                "name":"approver only",
                "value":"4"
            }]
      "note": 
  },
    {
      "object_name":"lieu_time",
      "type":"Boolean",
      "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":"available_to_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  }
]



GETretrieve for user

Route: {root}/v4/overtime-type/retrieve-for-user

Sample call: {root}/v4/overtime-type/retrieve-for-user/?

Request type User level Requires authentication Response type
URL STAFF Yes Array()

Params

Name Type Nullable? Required? Min. Max. Nest Custom
status_id CUSTOM OPTIONAL - disabled (0)
active (1)
both (99)
cURL
curl --location --request GET "{{ROOT}}overtime-type/retrieve-for-user/?status_id=0-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_type_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"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":"requires_approval",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"lieu_time",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"note_required",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



PUTupdate

Route: {root}/v4/overtime-type/update
Request type User level Requires authentication Response type
BODY SUPER USER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
overtime_type_id [INT32] REQUIRED 0 2147483647 - -
name STRING OPTIONAL 0 50 - -
code STRING OPTIONAL 0 2 - -
colour STRING OPTIONAL 0 7 - -
requires_approval [BOOLEAN] ✓ OPTIONAL - -
note_required [BOOLEAN] ✓ OPTIONAL - -
email_request_id CUSTOM ✓ OPTIONAL - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_approve_id CUSTOM ✓ OPTIONAL - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
email_cancel_id CUSTOM ✓ OPTIONAL - none (0)
staff approver notifier (1)
staff only (2)
staff approver (3)
approver only (4)
lieu_time [BOOLEAN] ✓ OPTIONAL - -
status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
available_to_id CUSTOM ✓ OPTIONAL - staff (100)
approver (200)
super user (300)
super user with staff hub (310)
message STRING OPTIONAL 0 500 - -
cURL
curl --location --request PUT "{{ROOT}}overtime-type/update/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"overtime_type_id": "123456","name": "sample","code": "sample","colour": "sample","requires_approval": false,"note_required": false,"email_request_id": "0","email_approve_id": "0","email_cancel_id": "0","lieu_time": false,"status_id": "0","available_to_id": "100","message": "sample"}'

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



DELETEdel

Route: {root}/v4/overtime-type/del

Sample call: {root}/v4/overtime-type/del/12345678/true

Request type User level Requires authentication Response type
URL SUPER USER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
overtime_type_id INT32 REQUIRED 0 2147483647 - -
force_removal BOOLEAN REQUIRED - -
cURL
curl --location --request DELETE "{{ROOT}}overtime-type/del/12345678true-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \


Standard response object returned, see API Overview for structure.

Don't have a WhosOff account yet?

Instantly reduce time spent on leave management with your FREE, no obligation trial today!
Sign up today and get until Saturday, 26th July 2025 to try the full service, for Free!

Get your instant FREE account today
Close [X] Book your FREE WhosOff demo today
Get a personalised demo

Discover how WhosOff can elevate your leave management processes with a 20-min guided walkthrough.

Book your demonstration now

Manage Cookie Consent

Cookies are used to store and/or access device information. Providing consent to these technologies allows us to process data such as browsing behaviour. Not consenting or removing consent may adversely affect some features and functions.

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.
Cookie Policy
Manage cookies