Controller : System Message

DEPRECATED: NO

get get Return to API overview

Calls: {root}/{version}/system message


GET/v4/system-message/get
Route {root}/v4/system-message/get
Request type URL
User level NONE
Requires authentication No
Response type Array()
Sample call{root}/v0/system-message/get

Sample cURL

curl --location --request GET "{{ROOT}}/v4/system-message/get/-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Sample response

[
    {
      "object_name":"system_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":"type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"available",
                "value":"1"
            },
            {
                "name":"maintenance",
                "value":"2"
            }]
      "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": 
  }
]
POST/v4/system-message/get
Route {root}/v4/system-message/get
Request type BODY
User level NONE
Requires authentication No
Response type Array()

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
version [INT32] REQUIRED 1 100 - -
major [BYTE] REQUIRED 0 255 - -
minor [BYTE] REQUIRED 0 255 - -
app_id STRING REQUIRED 16 16 - -
os STRING OPTIONAL 0 100 - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/system-message/get/" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"version": "123456","app_id": "sample","os": "sample"}'

Sample response

[
    {
      "object_name":"force_update",
      "type":"[Boolean]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"system_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":"type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"available",
                "value":"1"
            },
            {
                "name":"maintenance",
                "value":"2"
            }]
      "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": 
  }
]


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 October 2026 to try the full service, for Free!

Get your instant FREE account today