Controller : Department

VERSION: 4.0, DEPRECATED: NO

create retrieve update del Return to API overview

Calls: {root}/department

POSTcreate

Route:

{root}/v4/department/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	-	-
min_user	INT16		REQUIRED	0	32767	-	-

cURL

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

Response object

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

GETretrieve

Route:

{root}/v4/department/retrieve

Sample call: {root}/v4/department/retrieve/?department_id=12345678

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

Params

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
department_id	INT32		OPTIONAL	0	2147483647	-	-

cURL

curl --location --request GET "{{ROOT}}department/retrieve/?department_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":"department_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":"min_user",
      "type":"Int16",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

PUTupdate

Route:

{root}/v4/department/update

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

Params

Name	Type	Required?	Max.	Nest	Custom
department_id	[INT32]	REQUIRED	2147483647	-	-
name	STRING	OPTIONAL	50	-	-
min_user	INT16	OPTIONAL	32767	-	-

cURL

curl --location --request PUT "{{ROOT}}department/update/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"department_id": "123456","name": "sample"}'

Standard response object returned, see API Overview for structure.

Response object

[
]

DELETEdel

Route:

{root}/v4/department/del

Sample call: {root}/v4/department/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
department_id	INT32		REQUIRED	0	2147483647	-	-
force_removal	BOOLEAN		REQUIRED			-	-

cURL

curl --location --request DELETE "{{ROOT}}department/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.

Response object

[
]

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 Friday, 25th April 2025 to try the full service, for Free!

Get your instant FREE account today

Controller : Department

Calls: {root}/department

Don't have a WhosOff account yet?

Cookie settings for whosoff.com