S3ObjectMetadata
keystring · requiredsizeinteger · requiredcontentTypestring · requiredlastModifiedstring · date-time · required
S3ObjectListResponse
keystring · requiredsizeinteger · requiredcontentTypestring · requiredlastModifiedstring · date-time · required
ErrorResponse
errorstring · requiredHuman-readable error message describing the problem.
codestring · enum · requiredMachine-readable error code for programmatic handling.
Enum values:BAD_REQUESTINVALID_CRONINVALID_TIMEZONENO_FUTURE_OCCURRENCENOT_IMPLEMENTEDDST_AMBIGUOUSDST_NON_EXISTENTdetailsobject · requiredAdditional error context and troubleshooting information. Structure varies by error type.
timestampstring · date-time · requiredError occurrence timestamp in ISO8601 UTC format.
ParsedAddress
streetstring · requiredThe street address line (e.g., '6315 W Yucca St')
citystring · requiredThe city name
statestring · requiredState, province, or region code
zipstring · requiredPostal or ZIP code
countrystring · requiredCountry name
ReportData
reportIdstring · requiredUnique identifier for the generated report
generatedAtstring · date-time · requiredTimestamp when the report was generated
dataobjectThe actual report data (structure varies by report type)
parametersobjectParameters used to generate this report
TokenRequest
grant_typestring · enum · requiredEnum values:client_credentialsrefresh_tokenpasswordDefault: client_credentials
client_idstringclient_secretstringrefresh_tokenstringusernamestringpasswordstringscopestring
BaseResponse
successboolean · requiredmetadataobject · requiredstatusstring · requiredDescriptive status message
ScheduleNextRequest
cronstring · cron5 · required5-field CRON expression (minute hour day_of_month month day_of_week).
Format:
minute hour day_of_month month day_of_week- minute: 0-59
- hour: 0-23
- day_of_month: 1-31
- month: 1-12
- day_of_week: 0-7 (0 or 7 is Sunday)
Supported operators:
*,-,,,/Not supported: Quartz tokens (?,L,W,#), seconds field (6+ fields)
tzstring · iana-tzIANA timezone identifier for execution time calculation. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Default: UTCfromstring · date-time · pattern:.*Z$Starting time for next occurrence calculation in ISO8601 UTC format. Must end with 'Z' suffix. If not provided, defaults to current time.
ambiguityPolicystring · enumPolicy for handling DST ambiguity when local times are non-existent (spring-forward) or ambiguous (fall-back).
first-valid: Use the first valid time (default)second-valid: Use the second valid timeerror: Return error for ambiguous times
Enum values:first-validsecond-validerrorDefault: first-validmacrosbooleanEnable business macros processing. Currently not implemented in MVP. Future phases will support @EOM, @EOQ, @semi-monthly, etc.
Default: trueplainstringPlain language schedule input (e.g., "Every Monday at 9am").
Not implemented in MVP - Sending this field returns 501 NOT_IMPLEMENTED. Will be supported in Phase 6.
holidaysobjectHoliday configuration for filtering execution times. Currently only
use: 'none'is supported.
returnstring · enum · deprecated · requiredDEPRECATED: This parameter is deprecated and ignored. Both nextIso and nextDate are always returned regardless of this parameter's value.
Previously specified which timestamp formats to include in the response:
iso: Only nextIso field (ISO8601 with timezone offset)date: Only nextDate field (calendar date in target timezone)both: Both nextIso and nextDate fields (default)
For backwards compatibility, this field is still accepted but has no effect on the response format.
Enum values:isodatebothDefault: both
TimerNextRequest
cronstringfromstring · date-timetzstringreturnstring · enumEnum values:isodatebothDefault: bothambiguityPolicystring · enumEnum values:first-validsecond-validerrorDefault: first-valid
ScheduleNextResponse
nextIsostring · date-time · requiredNext execution time in ISO8601 UTC format. Always returned regardless of deprecated 'return' parameter.
nextDatestring · date · requiredNext execution date in YYYY-MM-DD format in the requested timezone. Always returned regardless of deprecated 'return' parameter.
schedlstring · requiredCanonical SCHEDL (Schedule Language) representation of the schedule. Format: "
tz= " expandedCronstring · requiredNormalized 5-field CRON string with single spaces when input is valid. Null if normalization cannot be produced, with warning added to warnings array.
explanationstring · requiredHuman-readable explanation of the schedule using 24-hour format. Format: "At HH:mm on
" warningsstring[] · requiredArray of human-readable warning codes about schedule processing. May include DST adjustments, deprecated parameter warnings, normalization fallback, etc.