Controller : User Restriction

VERSION: 4.0, DEPRECATED: NO

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

Calls: {root}/user restriction

POSTcreate

Route:

{root}/v4/user-restriction/create

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

Params

Name	Type	Required?	Min.	Max.	Nest	Custom
user_id	[INT32]	REQUIRED	0	2147483647	-	-
restricted_user_id	[INT32]	REQUIRED	0	2147483647	-	-
reverse_entry	[BOOLEAN]	REQUIRED			-	-

cURL

curl --location --request POST "{{ROOT}}user-restriction/create/" \
-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","restricted_user_id": "123456","reverse_entry": false}'

Response object

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

GETretrieve by user id

Route:

{root}/v4/user-restriction/retrieve-by-user-id

Sample call: {root}/v4/user-restriction/retrieve-by-user-id/12345678

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

Params

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

cURL

curl --location --request GET "{{ROOT}}user-restriction/retrieve-by-user-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":"user_restriction_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"restricted_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": 
  }
]

DELETEdel

Route:

{root}/v4/user-restriction/del

Sample call: {root}/v4/user-restriction/del/12345678

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

Params

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

cURL

curl --location --request DELETE "{{ROOT}}user-restriction/del/12345678-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 : User Restriction

Calls: {root}/user restriction

Don't have a WhosOff account yet?

Cookie settings for whosoff.com