POST/ retrieve
| Route | {root}/v4/company-message/retrieve |
| Request type | BODY |
| User level | STAFF |
| Requires authentication | Yes |
| Response type | Single |
Parameters
| Name | Type | Nullable? | Required? | Min. | Max. | Nest | Custom |
|---|---|---|---|---|---|---|---|
| start_date | DATE | REQUIRED | - | - | |||
| end_date | DATE | REQUIRED | - | - | |||
| map_type_id | CUSTOM | ✓ | OPTIONAL | - | |||
| map_id | [INT32] | ✓ | OPTIONAL | 0 | 2147483647 | - | - |
Sample 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 '{"map_type_id": "0","map_id": "123456"}'
Sample response
[
{
"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":
},
{
"object_name":"map_type_id",
"type":"[Byte]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"total",
"type":"[Int32]",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]