Overtime Type | API

POST/v4/create

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

Parameters

Name	Type	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	-	-

Sample cURL

curl --location --request POST "{{ROOT}}/v4/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"}'

Sample response

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

POST/v4/retrieve

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

Parameters

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
status_id	CUSTOM		REQUIRED	0	99	-	disabled (0) active (1) both (99)

Sample cURL

curl --location --request POST "{{ROOT}}/v4/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"}'

Sample response

[
    {
      "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": 
  }
]

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
overtime_type_id	INT32		REQUIRED	0	2147483647	-	-

Name

Type

Nullable?

Required?

Min.

Max.

Nest

Custom

overtime_type_id

INT32

REQUIRED

2147483647

curl --location --request GET "{{ROOT}}/v4/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: */*" \

[
{
"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":
}
]

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
status_id	CUSTOM		OPTIONAL			-	disabled (0) active (1) both (99)

Name

Type

Nullable?

Required?

Min.

Max.

Nest

Custom

status_id

CUSTOM

OPTIONAL

disabled (0)
active (1)
both (99)

curl --location --request GET "{{ROOT}}/v4/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: */*" \

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	-	-

Name

Type

Nullable?

Required?

Min.

Max.

Nest

Custom

overtime_type_id

[INT32]

REQUIRED

2147483647

name

STRING

OPTIONAL

code

STRING

OPTIONAL

colour

STRING

OPTIONAL

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

500

curl --location --request PUT "{{ROOT}}/v4/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"}'

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
overtime_type_id	INT32		REQUIRED	0	2147483647	-	-
force_removal	BOOLEAN		REQUIRED			-	-

Name

Type

Nullable?

Required?

Min.

Max.

Nest

Custom

overtime_type_id

INT32

REQUIRED

2147483647

force_removal

BOOLEAN

REQUIRED

curl --location --request DELETE "{{ROOT}}/v4/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: */*" \

Controller : Overtime Type

Calls: {root}/{version}/overtime type

Don't have a WhosOff account yet?

Manage Cookie Consent

Route	{root}/v4/overtime-type/retrieve-by-id
Request type	URL
User level	STAFF
Requires authentication	Yes
Response type	Array()
Sample call	{root}/v0/overtime-type/retrieve-by-id/12345678

Route	{root}/v4/overtime-type/retrieve-for-user
Request type	URL
User level	STAFF
Requires authentication	Yes
Response type	Array()
Sample call	{root}/v0/overtime-type/retrieve-for-user/?

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

Route	{root}/v4/overtime-type/del
Request type	URL
User level	SUPER USER
Requires authentication	Yes
Response type	Single
Sample call	{root}/v0/overtime-type/del/12345678/true