Validates announcement start and end times against the server timezone

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Validates the proposed announcement schedule times by checking them against the server's configured timezone. Accepts 'startTime', 'endTime', 'lapTime', and 'isMultipleTime' query parameters. Returns whether the time window is valid.

Request URL

https://{serverurl}/dcapi/tools/announcement/validateTime

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

startTimestringOptional

Announcement start time string. Validated against the server's configured timezone

endTimestringOptional

Announcement end time string. Must be after startTime. Validated against the server's configured timezone

lapTimestringOptional

Interval time between repeated announcement displays within the schedule window

isMultipleTimebooleanOptional

Set to true when the announcement should repeat multiple times within the schedule window

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/announcement/validateTime \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
isValidboolean

true if the provided start and end times form a valid schedule window

serverTimezonestring

Server timezone identifier used for time validation (e.g., America/New_York)

parsedStartTimelong

Epoch timestamp of the parsed start time in server timezone

parsedEndTimelong

Epoch timestamp of the parsed end time in server timezone

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "isValid": true,
    "serverTimezone": "America/New_York",
    "parsedStartTime": 1711400000000,
    "parsedEndTime": 1711436000000
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.