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

Request definition

Required keys are marked with a red triangle :small-red-triangle:

Name

Type

Description

PlaceID :small-red-triangle:

String

Place (client) code that will be assigned to this schedule

RepresentativeID :small-red-triangle:

String

Representative code that will be assigned tothis schedule

DateBegin :small-red-triangle:

Datetime

Date when schedule begins

RepeatEveryWeeks :small-red-triangle:

Integer

Interval for weekly schedule recurrence. 0 for non recurring schedule

VisitTime

Time

Time for scheduled visit, empty for any time visit

VisitDuration

Integer

Expected duration of scheduled visit in minutes

Tasks\TaskType

Array

List of scheduled tasks, for definition checktable below

Tasks array definition

Name

Type

Description

TaskType :small-red-triangle:

String

Type of task (Photo, Note, Form, Audit, Sales document)

TaskDescription :small-red-triangle:

String

Custom description for Photo or Note. Form, Audit and Sales document require their exacttitle as description

Response definition

Name

Type

Description

Code

Integer

Error identifier (0 = no errors)

Message

String (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