MobileApp

Create Reccurance Shedule

Changed on

Function: create_reccurance_shedule Type: API Endpoint (POST)

Purpose:
Creates a new recurrence schedule for a given template.

Request Body:

  • template_data (TemplateRecurrenceRequest, required): The data for the recurrence schedule, including the template code, report code, occurances, days, start date, end date, schedule time, and status.

Response:

  • Returns a success message if the recurrence schedule is created successfully.
  • Returns error messages if the customer key is invalid, or if the recurrence schedule already exists.

Error Handling:

  • Catches exceptions and returns a 500 error with the exception message.
post/api/MobileApp/templates/create_reccurance_shedule

Request

Headers

Customer-Keystring required

Request body

app_codestring required
template_codestring required
occuranceinteger required
mondayinteger
tuesdayinteger
wednesdayinteger
thursdayinteger
fridayinteger
saturdayinteger
sundayinteger
first_dayinteger
last_dayinteger
month_daysstring
janinteger
febinteger
marinteger
aprinteger
mayinteger
juninteger
julinteger
auginteger
sepinteger
octinteger
novinteger
decinteger
start_datestring date required
end_datestring date
indefiniteinteger
schedule_timestring time required
last_scheduled_timestring date-time
last_scheduled_statusinteger
next_schedule_timestring date-time required
whatsappinteger
emailinteger
schedule_formatstring
statusboolean required
modified_onstring date-time nullable
modified_bystring nullable
trigger_timestring time required
last_trigger_timestring date-time
next_trigger_timestring date-time
last_trigger_idstring nullable

Response

Successful Response

unknown required

Changes