Endpoint is used to import schedules from your system into Repsly.

Request definition

Required keys are marked with a red triangle 🔺

NameTypeDescription
PlaceID 🔺StringPlace (client) code that will be assigned to this schedule
RepresentativeID 🔺StringRepresentative code that will be assigned tothis schedule
DateBegin 🔺DatetimeDate when schedule begins
RepeatEveryWeeks 🔺IntegerInterval for weekly schedule recurrence. 0 for non recurring schedule
VisitTimeTimeTime for scheduled visit, empty for any time visit
VisitDurationIntegerExpected duration of scheduled visit in minutes
Tasks\TaskTypeArrayList of scheduled tasks, for definition checktable below

Tasks array definition

NameTypeDescription
TaskType 🔺StringType of task (Photo, Note, Form, Audit, Sales document)
TaskDescription 🔺StringCustom description for Photo or Note. Form, Audit and Sales document require their exacttitle as description

Response definition

NameTypeDescription
CodeIntegerError identifier (0 = no errors)
MessageString (255)Response affirmative or error message

For a successful HTTP request (code 200), you will always receive a status response with Code equal to 0 (no error) and Message = “Schedule import job started asynchronously under ID: {ImportJobID}”, where {ImportJobID} is the key you can use to check the current status of the import. To check the status of the import job you can use ​**Import job status​** endpoint.

In case of a HTTP bad request (code 400), you will also receive a status response with Code not equal to 0 and an error message.

Language