Controller : Tag

VERSION: 4.0, DEPRECATED: NO

create retrieve update del Return to API overview

Calls: {root}/tag

POSTcreate

Route:

{root}/v4/tag/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	100	-	-

cURL

curl --location --request POST "{{ROOT}}tag/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":"tag_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

GETretrieve

Route:

{root}/v4/tag/retrieve

Sample call: {root}/v4/tag/retrieve/?tag_id=12345678

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

Params

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

cURL

curl --location --request GET "{{ROOT}}tag/retrieve/?tag_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":"tag_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

PUTupdate

Route:

{root}/v4/tag/update

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

Params

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
tag_id	INT32		REQUIRED	0	2147483647	-	-
name	STRING		REQUIRED	0	100	-	-

cURL

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

Response object

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

DELETEdel

Route:

{root}/v4/tag/del

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

cURL

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

[
]

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 Thursday, 26th December 2024 to try the full service, for Free!

Start Your Free Trial

Controller : Tag

Calls: {root}/tag

Get your long FREE trial today!

GET A PERSONALISED DEMO

Cookie settings for whosoff.com