Skip to main content
Calculate Days

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

AppointmentEntity

CalculateDays: Calculates the set of dates that represents a recurrence pattern. Adds conflict information to each date.

AppointmentEntity
object

Partial AppointmentEntity class associating the generated AppointmentEntity with an interface.

Response

OK

Class representing the recurrence of an appointment booking

RecurrenceId
integer<int32>

The recurrence rule id

StartDate
string<date-time>

Start date of the repetition pattern

EndDate
string<date-time>

End date of the repetition pattern Only used when the end is calculated from a end date. {SuperOffice.Data.RecurrenceEndType.EndDate}

RecurrenceCounter
integer<int32>

Number of recurrences Only used when the end is calculated from a number of repetitions. {SuperOffice.Data.RecurrenceEndType.Counter}

RecurrenceEndType
enum<string>

Type defining how the end of the recurrence sequence should be calculated

Available options:
Unknown,
EndDate,
Counter
Pattern
enum<string>

The recurrence pattern (Daily, Weekly, Monthly, Yearly, Custom)

Available options:
Unknown,
Daily,
Weekly,
Monthly,
Yearly,
Custom
DayPattern
object

Class representing a pattern for daily recurrence

WeekPattern
object

Class representing a pattern for weekly recurrence

MonthPattern
object

Class representing a pattern for monthly recurrence

YearPattern
object

Class representing a pattern for yearly recurrence

Dates
object[]

List of all dates where this recurrence occurs

IsRecurrence
boolean

Get a or set IsRecurrence, indicating if this is a repeating appointment or not.