Controller : Company Message

VERSION: 4.0, DEPRECATED: NO

retrieve retrieve-by-id Return to API overview

Calls: {root}/company message

POSTretrieve

Route:

{root}/v4/company-message/retrieve

Request type	User level	Requires authentication	Response type
BODY	STAFF	Yes	Single

Params

Name	Type	Nullable?	Required?	Min.	Max.	Nest	Custom
start_date	DATE		REQUIRED			-	-
end_date	DATE		REQUIRED			-	-

cURL

curl --location --request POST "{{ROOT}}company-message/retrieve/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{}'

Response object

[
    {
      "object_name":"company_message_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

GETretrieve by id

Route:

{root}/v4/company-message/retrieve-by-id

Sample call: {root}/v4/company-message/retrieve-by-id/12345678

Request type	User level	Requires authentication	Response type
URL	STAFF	Yes	Single

Params

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

cURL

curl --location --request GET "{{ROOT}}company-message/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":"company_message_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_by_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_by",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]

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 Monday, 26th May 2025 to try the full service, for Free!

Get your instant FREE account today

Controller : Company Message

Calls: {root}/company message

Don't have a WhosOff account yet?

Cookie settings for whosoff.com