Skip to main content
Get Associates Diary Info

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

AssociateIds, StartTime, EndTime

GetAssociatesDiaryInfo: Fetch appointment info for given associates

AssociateIds
integer<int32>[]
StartTime
string<date-time>
EndTime
string<date-time>

Response

OK

AppointmentId
integer<int32>

The id of the appointment

AssociateId
integer<int32>

The id of the associate this appointment belongs to

MotherId
integer<int32>

The id of the mother appointment (participants point to this one)

StartDate
string<date-time>

The start of the appointment

EndDate
string<date-time>

The end of the appointment

ColorIndex
enum<string>

The color index of the appointment (task)

Available options:
LightBlue,
DarkBlue,
LightGray,
DarkGray,
LightGreen,
DarkGreen,
LightYellow,
DarkYellow,
LightRed,
DarkRed,
BlueAlt1,
BlueAlt2,
BlueAlt3,
GrayAlt1,
GrayAlt2,
GrayAlt3,
GreenAlt1,
GreenAlt2,
GreenAlt3,
YellowAlt1,
YellowAlt2,
YellowAlt3,
RedAlt1,
RedAlt2,
RedAlt3
TaskName
string

The name of the appointment task type

ContactName
string

The name of the appointment contact.

ProjectName
string

The name of the appointment project

Title
string

The appointment title (first line of appointment description)

Agenda
string

The appointment agenda (the rest of appointment description)

IsAllDay
boolean

True if the appointment is an all day appointment

IsBusy
boolean

True if the participant is marked as busy

IsRecurring
boolean

True if the appointment is part of a recurring series

IsVideoMeeting
boolean

True if the appointment has a video link

HasAlarm
boolean

True if the appointment has alarm

IsCompleted
boolean

True if the appointment is completed

IsTentative
boolean

True if the appointment is tentative

IsBookingMain
boolean

True if the appointment is a main booking

SendEmail
boolean

True if the appointment record has the email flag set

AnySendEmail
boolean

True if any of the appointment records has the email flag set

IsPrivate
boolean

True if only visible for the owner

RecurrenceInfo
object

Class representing the recurrence of an appointment booking

PersonName
string

The name of the appointment person.

IsBooking
boolean

True if the appointment is part of a booking

OwnedExternally
enum<string>

Set if an external system owns this appointment.

Available options:
None,
Other,
Outlook,
Google
MotherAssociateId
integer<int32>

Associate/owner of the mother appointment

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.