<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent”></a> Interface IAppointmentAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Collection of all services that works with Appointment data.
Implements
IAgentBase, IDisposableMethods
<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_AcceptAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> AcceptAsync(int, RecurrenceUpdateMode, RequestOptions)
Accepting an appointment invitation.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_AcceptRejectedAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> AcceptRejectedAsync(int, RecurrenceUpdateMode, RequestOptions)
Accept that an invited participant has rejected your invitation or assignment.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_AcceptWithEmailConfirmationAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> AcceptWithEmailConfirmationAsync(int, RecurrenceUpdateMode, RequestOptions)
Accepting an appointment invitation and send an email confirmation to the meeting organizer.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_AcceptWithSmtpEmailConfirmationAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_RequestOptions_”></a> AcceptWithSmtpEmailConfirmationAsync(int, RecurrenceUpdateMode, EMailConnectionInfo, RequestOptions)
Accepting an appointment invitation and send an email confirmation to the meeting organizer.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_AssignToAsync_System_Int32_SuperOffice_WebApi_Data_ParticipantInfo_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> AssignToAsync(int, ParticipantInfo, RecurrenceUpdateMode, RequestOptions)
Assigning an appointment to another person.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
participant ParticipantInfo
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CalculateDaysAsync_SuperOffice_WebApi_Data_AppointmentEntity_SuperOffice_WebApi_RequestOptions_”></a> CalculateDaysAsync(AppointmentEntity, RequestOptions)
Calculates the set of dates that represents a recurrence pattern. Adds conflict information to each date.Parameters
appointmentEntity AppointmentEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RecurrenceInfo><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CanAssignToProjectMemberAsync_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> CanAssignToProjectMemberAsync(int, int, RequestOptions)
Parameters
projectId int
suggestedAppointmentId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CleanUpBookingDeletedAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> CleanUpBookingDeletedAsync(int[], RequestOptions)
Deletes all appointments(within the appointmentIds array) with status BookingDeleted.Parameters
appointmentIds int[]
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int> Number of modified or deleted appointments<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CleanUpBookingDeletedWithUpdateModeAsync_System_Int32___SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> CleanUpBookingDeletedWithUpdateModeAsync(int[], RecurrenceUpdateMode, RequestOptions)
Deletes all appointments(within the appointmentIds array) with status BookingDeleted. All appointments in the list will be deleted using the same recurrence update mode.Parameters
appointmentIds int[]
List of appointment IDs
updateMode RecurrenceUpdateMode
Update mode
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CleanUpRecurringBookingDeletedAsync_SuperOffice_WebApi_RequestOptions_”></a> CleanUpRecurringBookingDeletedAsync(RequestOptions)
Deletes all appointments with status BookingDeleted and for in logged user.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ConvertAppointmentToTaskAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> ConvertAppointmentToTaskAsync(int, RequestOptions)
Convert appointment to task if certain criteria are met (participants < 2)Parameters
appointmentId int
Appointment ID
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Appointment entity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateAndAcceptAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> CreateAndAcceptAsync(int, RecurrenceUpdateMode, RequestOptions)
Creating an appointment from an emailItem invitation and accepting it.Parameters
emailItemId int
The emailItemId
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateAndAcceptWithEmailConfirmationAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> CreateAndAcceptWithEmailConfirmationAsync(int, RecurrenceUpdateMode, RequestOptions)
Creating an appointment from an emailItem invitation and accepting it with email confirmation to the meeting organizer.Parameters
emailItemId int
The emailItemId
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateAppointmentEntityFromExistingAsync_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> CreateAppointmentEntityFromExistingAsync(int, int, RequestOptions)
Creates an AppointmentEntity populated with values from an existing appointment. The new appointment will get the same task type and participant list as the source appointment. The date of the new appointment will be set to today, but the time component is kept.Parameters
appointmentId int
Source appointment ID
associateId int
Associate owning the new appointment. If 0 the current associate is used.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> AppointmentEntity with values copied from an existing appointment. Values that are not copied will be the default values.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateAppointmentForUIDAsync_SuperOffice_WebApi_Data_AppointmentEntity_System_String_SuperOffice_WebApi_RequestOptions_”></a> CreateAppointmentForUIDAsync(AppointmentEntity, string, RequestOptions)
Create an invitation record and an appointment with a given UID to reserve it if the UID is unused, otherwise null.Parameters
appointmentEntity AppointmentEntity
uID string
The UID associated with the appointment
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> The newly created AppointmentEntity or null if the UID is in the DB already.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultAppointmentEntityAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultAppointmentEntityAsync(RequestOptions)
Set default values into a new AppointmentEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> A blank AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultAppointmentEntityByTypeAndAssociateAsync_SuperOffice_WebApi_Data_TaskType_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultAppointmentEntityByTypeAndAssociateAsync(TaskType, int, RequestOptions)
Creates a AppointmentEntity populated with the default values for the specific type and owner.Parameters
type TaskType
The type of task requested.
associateId int
The associateId of the appointment owner.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> AppointmentEntity with default values.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultAppointmentEntityByTypeAsync_SuperOffice_WebApi_Data_TaskType_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultAppointmentEntityByTypeAsync(TaskType, RequestOptions)
Creates an AppointmentEntity populated with the default values for the specific type.Parameters
type TaskType
The type of task requested.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> AppointmentEntity with default values.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultAppointmentEntityFromProjectSuggestionAsync_System_Int32_System_Int32_System_Boolean_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultAppointmentEntityFromProjectSuggestionAsync(int, int, bool, int, RequestOptions)
Parameters
suggestedAppointmentId int
projectId int
createNow bool
ownerId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultAppointmentEntityFromSaleSuggestionAsync_System_Int32_System_Int32_System_Boolean_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultAppointmentEntityFromSaleSuggestionAsync(int, int, bool, int, RequestOptions)
Creates an appointment based on a suggested appointment.Parameters
suggestedAppointmentId int
The id of the suggested appointment
saleId int
This is the id of the sale the appointment is connected to. This will be used to give the appointment it’s starting date. If the id is 0 or invalid, we assume the start date is now
createNow bool
If this parameter is true, we override the suggested start time and create the appointment with the current date and time
ownerId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> The newly created appointment<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultReOpenAppointmentAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultReOpenAppointmentAsync(int, RequestOptions)
A re-open appointment should be created as a reminder to re-open the sale at a certain date with information regarding the stalled sale.Parameters
saleId int
The identifier of the stalled sale from which we create a re-open appointment
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> The re-open appointment with start date = the re-open date of the sale and a description matching the sales stalled reason.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultRecurrenceAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultRecurrenceAsync(RequestOptions)
Creates a RecurrenceInfo object populated with the default values for the specific type.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RecurrenceInfo> RecurrenceInfo object with default values.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultRecurrenceByDateAsync_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultRecurrenceByDateAsync(DateTime, RequestOptions)
Creates a RecurrenceInfo object populated with the default values for the specific type. Using startDate as start date for the recurreing pattern.Parameters
startDate DateTime
Date of which the recurring pattern should start.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RecurrenceInfo><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultSuggestedAppointmentEntityAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultSuggestedAppointmentEntityAsync(RequestOptions)
Set default values into a new SuggestedAppointmentEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SuggestedAppointmentEntity> A blank SuggestedAppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateDefaultTaskListItemAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultTaskListItemAsync(RequestOptions)
Set default values into a new TaskListItem. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskListItem> A blank TaskListItem<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_CreateVideoMeetingReservationAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateVideoMeetingReservationAsync(RequestOptions)
Create a VideoMeetingReservation. System users are not allowed to create video meeting reservationsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<VideoMeetingReservation> The created VideoMeetingReservation.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_DeclineInvitationFromEmailItemAsync_System_Int32_System_String_SuperOffice_WebApi_RequestOptions_”></a> DeclineInvitationFromEmailItemAsync(int, string, RequestOptions)
Declining an appointment invitation where no tentative appointments have been created.Parameters
emailItemId int
The emailItemId.
rejectReason string
The reason the invitation was rejected.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_DeleteAppointmentEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteAppointmentEntityAsync(int, RequestOptions)
Deletes the AppointmentEntityParameters
appointmentEntityId int
The identity of the AppointmentEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_DeleteAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_System_Boolean_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_RequestOptions_”></a> DeleteAsync(int, RecurrenceUpdateMode, bool, EMailConnectionInfo, EMailConnectionInfo, RequestOptions)
Deleting a bookingParameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
sendEmailToParticipants bool
If true, emails will be sent to all participants that is marked with send email flag. If false no mails will be sent even if the send email flag is true.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
imapEMailConnectionInfo EMailConnectionInfo
Login information for imap server. Will be null if no login information is relevant.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_DeleteVideoMeetingReservationAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> DeleteVideoMeetingReservationAsync(string, RequestOptions)
Delete a VideoMeetingReservation.Parameters
videoMeetingId string
The VideoMeetingReservation.VideoMeetingId to remove. System users are not allowed to delete video meeting reservations
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GenerateLeadAsync_System_Int32_System_String_System_String_System_Int32_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GenerateLeadAsync(int, string, string, int, string, string, string, string, string, string, string, string, RequestOptions)
Adds a sales lead (task) to a contact in SuperOffice. If the contact or person is known, the sales lead is added to the current contact. If not, a new contact is created, with the associate with ownerIdForNewContact as responsible (Our Contact). A relation is created between the contact and the person submitting the lead. Based on wether the person the request is made for is found or not, the following happens: If the person is found, the person, person’s contact and sales representative is returned. If neither the person nor the contact is found a new person and contact is created (if sufficient data is supplied), and the person, person’s contact and sales representative is returned. If the contact and not the person is found a new person is created on this contact, and the contact, salesrep, and person is returned (if there was enough data to return the person). If more than one contact is found a list of contacts is returned.Parameters
associateIdForNewContact int
Associate id of the person set as “Our Contact” if a new Contact is created. Ensures that the sales lead is assigned to the correct salesman.
leadDescription string
Description of the lead. The lead text as shown in SuperOffice
relation string
The relation the person submitting the lead has to the contact.
relationId int
Id of the relation type. Database specific.
leadContact string
Name of the new or existing contact (company) the lead is created for.
leadPersonFirstname string
Firstname of the contact’s person.
leadPersonLastname string
Lastname of the contact’s person.
leadPersonEmail string
Email to the contact’s person.
leadPhoneNumber string
Phone number of the contact or contact’s person.
creatorsContact string
The contact (company) of the person creating the lead
creatorsFirstname string
The firstname of the person creating the lead
creatorsLastname string
The lastname of the person creating the lead
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SalesActivity> True if successfull.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetActivityInformationListByDatesAndAssociateAsync_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetActivityInformationListByDatesAndAssociateAsync(DateTime, DateTime, int, RequestOptions)
Get activity information for one or more days according to the given date interval. The time portion of the dates is ignored. Private appointments are counted, but may not be visible through tooltips or other more detailed services.Parameters
startDate DateTime
Start date of interval. Time portion is ignored.
endDate DateTime
End date of interval. Time portion is ignored.
associateId int
Associate id to identify the calendar to scan. If 0 is passed in, the currently authenticated associate is used instead.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ActivityInformationListItem[]> Exactly one item per day of the given time span is returned. Days where nothing happens will have all values set to 0, but will still be in the returned array. Start end dates are treated as inclusive.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAlarmsAsync_System_Boolean_System_Boolean_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAlarmsAsync(bool, bool, int, RequestOptions)
Parameters
includeInvitations bool
includeAllAppointments bool
defaultAlarmLeadTimeInMinutes int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<MultiAlarmData><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentAsync(int, RequestOptions)
Gets a specific Appointment object.Parameters
appointmentId int
The identifier of the Appointment object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment> Appointment<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentEmailInvitationAsync_SuperOffice_WebApi_Data_AppointmentEntity_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentEmailInvitationAsync(AppointmentEntity, string, string, RequestOptions)
Create an EMailEntity (without an ical attachment) with the email sent to participants when the appointment is savedParameters
appointment AppointmentEntity
The appointment carrier with changes made.
templateName string
Filename of invitation template
language string
The desired SO-language for the template
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<EMailEntity> Email entity with the preview in HTMLBody<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentEntityAsync(int, RequestOptions)
Gets a specific AppointmentEntity object.Parameters
appointmentEntityId int
The identifier of the AppointmentEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentFromUIDAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentFromUIDAsync(string, RequestOptions)
Get the appointment that corresponds to the given UID.Parameters
uID string
The UID associated with the appointment
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> The corresponding AppointmentEntity if exists or a default appointment entity.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentHaveParticipantsWithEmailAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentHaveParticipantsWithEmailAsync(int, RequestOptions)
GetAppointmentHaveParticipantsWithEmail will check if any of the participants is marked to receive emails on this appointment. If no participants are defined, false will be returned.Parameters
appointmentId int
The appointmentId.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> Return true or false.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentListAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentListAsync(int[], RequestOptions)
Gets an array of specific Appointment objects.Parameters
appointmentIds int[]
The identifiers of the Appointment object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointment objects<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentRecordsAsync_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentRecordsAsync(int, int, RequestOptions)
Get all records involved in a booking and/or recurring appointments. MotherId can be zero for repeating appointments or bookings, and recurrenceRuleId can be zero for bookings that are not repeating.Parameters
motherId int
Appointment id of the owner of a booking
recurrenceRuleId int
RecurrenceId of a recuring appointment
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAppointmentsByTaskHeadingAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAppointmentsByTaskHeadingAsync(int, RequestOptions)
Method that returns appointments of a specific appointment task heading. Task represents the different types of activities, like “Phone call”, “Meeting” and so on. The heading represents a grouping or filtering of tasks.Parameters
taskHeadingId int
The task heading id. The heading represents a grouping or filtering of tasks. Task represents the different types of activities, like “Phone call”, “Meeting” and so on
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAssociateDiaryAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetAssociateDiaryAsync(int, DateTime, DateTime, int, RequestOptions)
Parameters
associateId int
startTime DateTime
endTime DateTime
count int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAssociatesDiaryAsync_System_Int32___System_DateTime_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> GetAssociatesDiaryAsync(int[], DateTime, DateTime, RequestOptions)
Fetch appointments for given associatesParameters
associateIds int[]
startTime DateTime
endTime DateTime
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetAssociatesDiaryInfoAsync_System_Int32___System_DateTime_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> GetAssociatesDiaryInfoAsync(int[], DateTime, DateTime, RequestOptions)
Fetch appointment info for given associatesParameters
associateIds int[]
startTime DateTime
endTime DateTime
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentInfo[]><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetCanInsertForAssociatesAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetCanInsertForAssociatesAsync(int[], RequestOptions)
Check if current associate can create appointments in the diary of other associates.Parameters
associateIds int[]
Array of associate ids to check for.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool[]> Returns an array of bool corresponding to the associate array input parameter.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetContactAppointmentsAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetContactAppointmentsAsync(int, DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. The appointments belong to the contact specified. If the logged on user is not allowed to view this persons appointments an exception is thrown.Parameters
contactId int
The contact id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetContactAppointmentsByTaskAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetContactAppointmentsByTaskAsync(int, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the contact specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
contactId int
The contact id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskId int
The task id. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetContactAppointmentsByTaskHeadingAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetContactAppointmentsByTaskHeadingAsync(int, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the contact specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on. The heading represents a grouping or filtering of tasks.Parameters
contactId int
The contact id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskHeadingId int
The task heading id. The heading represents a grouping or filtering of tasks. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetContactAppointmentsByTasksAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetContactAppointmentsByTasksAsync(int, DateTime, DateTime, int, int[], RequestOptions)
Method that returns a specified number of appointments belonging to an array of appointment task types within a time range. The appointments belong to the contact specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
contactId int
The contact id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskIds int[]
The task ids as an integer array. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetContactAppointmentsByTypeAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_Data_AppointmentType_SuperOffice_WebApi_RequestOptions_”></a> GetContactAppointmentsByTypeAsync(int, DateTime, DateTime, int, AppointmentType, RequestOptions)
Method that returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the contact specified. If the logged on user is not allowed to view this contacts appointments an exception is thrown.Parameters
contactId int
The contact id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
appointmentType AppointmentType
The appointment type, e.g. inDiary, inChecklist etc.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetDayInformationListByDatesAndAssociateAsync_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetDayInformationListByDatesAndAssociateAsync(DateTime, DateTime, int, RequestOptions)
Get combined day information (activity + redletter summary) for one or more days according to the given date interval. The time portion of the dates is ignored. Private appointments are counted, but may not be visible through tooltips or other more detailed services.Parameters
startDate DateTime
Start date of interval. Time portion is ignored.
endDate DateTime
End date of interval. Time portion is ignored.
associateId int
Associate id to identify the calendar to scan. If 0 is passed in, the currently authenticated associate is used instead.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DayInformationListItem[]> Exactly one item per day of the given time span is returned. Days where nothing happens will have all values set to 0, but will still be in the returned array. Start end dates are treated as inclusive.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetDiaryByGroupAsync_System_Int32_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetDiaryByGroupAsync(int, int, DateTime, DateTime, int, RequestOptions)
Parameters
groupId int
groupType int
startTime DateTime
endTime DateTime
count int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetMyAppointmentsAsync_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetMyAppointmentsAsync(DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. The appointments belong to the currently logged on user.Parameters
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetMyDiaryAsync_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetMyDiaryAsync(DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. It only returns appointments that would be displayed in the user’s diary. The appointments belong to the currently logged on user.Parameters
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetMyPublishedAppointmentsAsync_SuperOffice_WebApi_RequestOptions_”></a> GetMyPublishedAppointmentsAsync(RequestOptions)
Get published appointments from the logged in user.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Appointments<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetMySyncAppointmentsAsync_System_DateTime_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> GetMySyncAppointmentsAsync(DateTime, DateTime, RequestOptions)
Method that returns a specified number of appointments within a time range. The appointments belong to the currently logged on user.Parameters
startTime DateTime
The start of the time interval in which we want appointments. This will usually be the current time.
endTime DateTime
The end of the time interval.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentSyncData[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetMyTasksAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetMyTasksAsync(int, RequestOptions)
Method that returns a specified number of appointments within a time range. It only returns appointments that would be displayed in the user’s task list. The appointments belong to the currently logged on user.Parameters
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetNextAvailableTimeAsync_System_Int32___System_DateTime_System_DateTime_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetNextAvailableTimeAsync(int[], DateTime, DateTime, int, bool, RequestOptions)
An array of the soonest-available working time slots.Parameters
associates int[]
Associate participants we want to account for while finding the next available times.
startTime DateTime
The start of the time interval we want appointments from.
endTime DateTime
The end of the time interval.
count int
How many next-available date time slots should be returned.
isAllDay bool
Is the appointment an all day event.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<NextAvailableTime[]> Array of the soonest-available working time slots.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetNextSuggestedAppointmentBySaleAsync_System_Int32_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetNextSuggestedAppointmentBySaleAsync(int, int, bool, RequestOptions)
Gets the next suggested appointment for a given sale (or rather a given sale’s guide).Parameters
saleId int
The identifier of the (guided) sale from which we want to find a suggested appointment
currentAppointmentId int
The identifier of the appointment from which we calculate the next suggestion. The next suggested appointment is the subsequent appointment defined in the SoAdmin’s sales guide.
skipCompleteCheck bool
If you want to get the next appointment step in a sales guide for an appointment which is not completed, this value must be true. In all other cases, this value should be false, as it would return the value of null if the current appointment is not completes.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SuggestedAppointment> The next suggestion based on the sale id of a guided sale and the id of the current apopintment. If we cannot find a next suggestion or the sale is not guided (or if any of the paramters are invalid), we will return null.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetOrganizerNameAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetOrganizerNameAsync(int, RequestOptions)
Lookup the name / email of an event-organizerParameters
motherAppointmentId int
The id of the mother-appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The displayed name of the organizer: name or email<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonAppointmentsAsync_System_Int32_System_Boolean_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPersonAppointmentsAsync(int, bool, DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. The appointments belong to the person specified. If the person not is a SuperOffice user (associate) or the logged on user is not allowed to view this persons appointments an exception is thrown.Parameters
personId int
The person id of the SuperOffice user (associate).
includeProjectAppointments bool
If true, all appointments that belong to projects where the user is a project member are included as well as the appointments belonging to the person.
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonAppointmentsByTaskAsync_System_Int32_System_Boolean_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPersonAppointmentsByTaskAsync(int, bool, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the person specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
personId int
The person id of the SuperOffice user (associate).
includeProjectAppointments bool
If true, all appointments that belong to projects where the user is a project member are included as well as the appointments belonging to the person.
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskId int
The task id. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonAppointmentsByTaskHeadingAsync_System_Int32_System_Boolean_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPersonAppointmentsByTaskHeadingAsync(int, bool, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the person specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on. The heading represents a grouping or filtering of tasks.Parameters
personId int
The person id of the SuperOffice user (associate).
includeProjectAppointments bool
If true, all appointments that belong to projects where the user is a project member are included as well as the appointments belonging to the person.
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskHeadingId int
The task heading id. The heading represents a grouping or filtering of tasks. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonAppointmentsByTasksAsync_System_Int32_System_Boolean_System_DateTime_System_DateTime_System_Int32_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetPersonAppointmentsByTasksAsync(int, bool, DateTime, DateTime, int, int[], RequestOptions)
Method that returns a specified number of appointments from a list of appointment task types within a time range. The appointments belong to the person specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
personId int
The person id of the SuperOffice user (associate).
includeProjectAppointments bool
If true, all appointments that belong to projects where the user is a project member are included as well as the appointments belonging to the person.
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskIds int[]
The task ids as an integer array. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonAppointmentsByTypeAsync_System_Int32_System_Boolean_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_Data_AppointmentType_SuperOffice_WebApi_RequestOptions_”></a> GetPersonAppointmentsByTypeAsync(int, bool, DateTime, DateTime, int, AppointmentType, RequestOptions)
Method that returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the person specified.Parameters
personId int
The person id of the SuperOffice user (associate).
includeProjectAppointments bool
If true, all appointments that belong to projects where the user is a project member are included as well as the appointments belonging to the person.
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
appointmentType AppointmentType
The appointment type, e.g. inDiary, inChecklist etc.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonDiaryAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPersonDiaryAsync(int, DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. It only returns appointments that would be displayed in the user’s diary. The appointments belong to the person specified. If the person not is a SuperOffice user (associate) or the logged on user is not allowed to view this persons appointments an exception is thrown.Parameters
personId int
The person id of the SuperOffice user (associate).
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPersonTasksAsync_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPersonTasksAsync(int, int, RequestOptions)
Method that returns a specified number of appointments within a time range. It only returns appointments that would be displayed in the user’s task list. The appointments belong to the person specified. If the person not is a SuperOffice user (associate) or the logged on user is not allowed to view this persons appointments an exception is thrown.Parameters
personId int
The person id of the SuperOffice user (associate).
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectAppointmentsAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProjectAppointmentsAsync(int, DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. The appointments belong to the project specified. If the logged on user is not allowed to view this projects appointments an exception is thrown.Parameters
projectId int
The project id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectAppointmentsByTaskAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProjectAppointmentsByTaskAsync(int, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the project specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
projectId int
The project id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskId int
The task id. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectAppointmentsByTaskHeadingAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProjectAppointmentsByTaskHeadingAsync(int, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the project specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on. The heading represents a grouping or filtering of tasks.Parameters
projectId int
The project id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskHeadingId int
The task heading id. The heading represents a grouping or filtering of tasks. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectAppointmentsByTasksAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetProjectAppointmentsByTasksAsync(int, DateTime, DateTime, int, int[], RequestOptions)
Method that returns a specified number of appointments matching the list of appointment task types within a time range. The appointments belong to the project specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
projectId int
The project id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskIds int[]
The task ids as an integer array. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectAppointmentsByTypeAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_Data_AppointmentType_SuperOffice_WebApi_RequestOptions_”></a> GetProjectAppointmentsByTypeAsync(int, DateTime, DateTime, int, AppointmentType, RequestOptions)
Method that returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the project specified.Parameters
projectId int
The project id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
appointmentType AppointmentType
The appointment type, e.g. inDiary, inChecklist etc.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectMemberAppointmentsAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProjectMemberAppointmentsAsync(int, DateTime, DateTime, int, RequestOptions)
Method that returns a specified number of appointments within a time range. The appointments belong to the projects where the person specified is member.Parameters
personId int
The project member’s person id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectMemberAppointmentsByTaskAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProjectMemberAppointmentsByTaskAsync(int, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the projects where the person specified is member. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
personId int
The project member’s person id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskId int
The task id. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectMemberAppointmentsByTaskHeadingAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProjectMemberAppointmentsByTaskHeadingAsync(int, DateTime, DateTime, int, int, RequestOptions)
Method that returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the projects where the person specified is member. Task represents the different types of activities, like “Phone call”, “Meeting” and so on. The heading represents a grouping or filtering of tasks.Parameters
personId int
The project member’s person id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskHeadingId int
The task heading id. The heading represents a grouping or filtering of tasks. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectMemberAppointmentsByTasksAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetProjectMemberAppointmentsByTasksAsync(int, DateTime, DateTime, int, int[], RequestOptions)
Method that returns a specified number of appointments matching a set of appointment task types within a time range. The appointments belong to the projects where the person specified is member. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.Parameters
personId int
The project member’s person id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
taskIds int[]
The task ids as an integer array. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetProjectMemberAppointmentsByTypeAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_Data_AppointmentType_SuperOffice_WebApi_RequestOptions_”></a> GetProjectMemberAppointmentsByTypeAsync(int, DateTime, DateTime, int, AppointmentType, RequestOptions)
Method that returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the projects where the person specified is member.Parameters
personId int
The project member’s person id
startTime DateTime
The start of the time interval we want appointments from. This will usually be the current time.
endTime DateTime
The end of the time interval.
count int
The maximum number of appointments that should be returned. -1 means no count restrictions.
appointmentType AppointmentType
The appointment type, e.g. inDiary, inChecklist etc.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointments.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPublishedAppointmentAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPublishedAppointmentAsync(int, RequestOptions)
Get published appointment by appointment id.Parameters
appointmentId int
The appointment id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment> Appointment<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPublishedAppointmentsAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetPublishedAppointmentsAsync(int[], RequestOptions)
Get published appointments by appointment ids.Parameters
appointmentIds int[]
The array of appointment ids
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointment<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetPublishedProjectAppointmentsAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPublishedProjectAppointmentsAsync(int, RequestOptions)
Get published appointments by project id.Parameters
projectId int
The project id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment[]> Array of Appointment<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetRedLetterInformationListByDatesAndAssociateAsync_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetRedLetterInformationListByDatesAndAssociateAsync(DateTime, DateTime, int, RequestOptions)
Get detailed red letter day information (redletter summary + individual day texts) for one or more days according to the given date interval. The time portion of the dates is ignored.Parameters
startDate DateTime
Start date of interval. Time portion is ignored.
endDate DateTime
End date of interval. Time portion is ignored.
associateId int
Associate id to identify the calendar to scan. If 0 is passed in, the currently authenticated associate is used instead.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RedLetterInformationListItem[]> Exactly one item per day of the given time span is returned. Days where nothing happens will have all values set to 0, but will still be in the returned array. Start end dates are treated as inclusive.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetSuggestedAppointmentAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSuggestedAppointmentAsync(int, RequestOptions)
Gets a specific SuggestedAppointment object.Parameters
suggestedAppointmentId int
The identifier of the SuggestedAppointment object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SuggestedAppointment> SuggestedAppointment<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetSuggestedAppointmentEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSuggestedAppointmentEntityAsync(int, RequestOptions)
Gets a specific SuggestedAppointmentEntity object.Parameters
suggestedAppointmentEntityId int
The identifier of the SuggestedAppointmentEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SuggestedAppointmentEntity> SuggestedAppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetTaskListItemAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetTaskListItemAsync(int, RequestOptions)
Gets a specific TaskListItem object.Parameters
taskListItemId int
The identifier of the TaskListItem object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskListItem> TaskListItem<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetTaskListItemsAsync_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetTaskListItemsAsync(bool, RequestOptions)
Gets all takslist itemsParameters
includeDeleted bool
Include deleted items
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskListItem[]> An array of tasklist items<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetUIDFromAppointmentIdAsync_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetUIDFromAppointmentIdAsync(int, bool, RequestOptions)
Get the UID associated with the appointment id in the Invitation table.Parameters
appointmentId int
useMotherId bool
Uses motherId if no UID is found for appointmentId.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The associated UID, or null if none exist.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_GetVideoMeetingConnectedStateAsync_SuperOffice_WebApi_RequestOptions_”></a> GetVideoMeetingConnectedStateAsync(RequestOptions)
Get the current users connected state. This indicates if a user is configured to use VideoMeetings.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<UserConnectedState> Details about the users connected state<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_MoveAsync_System_Int32_System_DateTime_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> MoveAsync(int, DateTime, RecurrenceUpdateMode, RequestOptions)
Moving a booking to another start time.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
newStartTime DateTime
The new start time for the moved booking.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_MoveExtendedAsync_SuperOffice_WebApi_Data_AppointmentMoveData_SuperOffice_WebApi_RequestOptions_”></a> MoveExtendedAsync(AppointmentMoveData, RequestOptions)
Moving a booking to another start time and with new info and possibly notifications.Parameters
appointmentMoveData AppointmentMoveData
Move parameter data.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_MoveWithEmailAsync_System_Int32_System_DateTime_SuperOffice_WebApi_Data_RecurrenceUpdateMode_System_Boolean_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_RequestOptions_”></a> MoveWithEmailAsync(int, DateTime, RecurrenceUpdateMode, bool, EMailConnectionInfo, EMailConnectionInfo, RequestOptions)
Moving a booking to another start time.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
newStartTime DateTime
The new start time for the moved booking.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
sendEmailToParticipants bool
If true, emails will be sent to all participants that is marked with send email flag if deemed necessary. If false no mails will be sent even if the send email flag is true.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
imapEMailConnectionInfo EMailConnectionInfo
Login information for imap server. Will be null if no login information is relevant.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_RejectAsync_System_Int32_System_String_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> RejectAsync(int, string, RecurrenceUpdateMode, RequestOptions)
Rejecting an appointment invitationParameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
rejectReason string
The reason the invitation was rejected.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_RejectWithEmailConfirmationAsync_System_Int32_System_String_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> RejectWithEmailConfirmationAsync(int, string, RecurrenceUpdateMode, RequestOptions)
Rejecting an appointment invitation and send an email confirmation to the meeting organizer.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
rejectReason string
The reason the invitation was rejected.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_RejectWithSmtpEmailConfirmationAsync_System_Int32_System_String_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_RequestOptions_”></a> RejectWithSmtpEmailConfirmationAsync(int, string, RecurrenceUpdateMode, EMailConnectionInfo, RequestOptions)
Rejecting an appointment invitation and send an email confirmation to the meeting organizer.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
rejectReason string
The reason the invitation was rejected.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_RequestForInfoAsync_System_Int32_System_String_System_String_System_String_System_String_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> RequestForInfoAsync(int, string, string, string, string, string, string, string, RequestOptions)
Submits a request for information. The request is added to the task list of the user that is responsible for this contact. Based on wether the person the request is made for is found or not, the following happens: If the person is found, the person, person’s contact and sales representative is returned. If neither the person nor the contact is found a new person and contact is created (if sufficient data is supplied), and the person, person’s contact and sales representative is returned. If the contact and not the person is found a new person is created on this contact, and the contact, salesrep, and person is returned (if there was enough data to return the person). If more than one contact is found a list of contacts is returned.Parameters
associateIdForNewContact int
Associate id of the person set as “Our Contact” if a new Contact is created. Ensures that the request is assigned to the correct salesman.
channel string
The requested channel, e.g. “Phone”
regarding string
The text submitted by the user.
contactName string
The name of the contact that the RFI will be added to. May be empty.
personFirstname string
The firstname of the person that the RFI will be added to. May be empty.
personLastname string
The lastname of the person that the RFI will be added to. May be empty.
emailAddress string
The email address of the person that the RFI will be added to.
phoneNumber string
Phone number of the contact or contact’s person.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SalesActivity> True if the submission was successful.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SaveAppointmentEntityAsync_SuperOffice_WebApi_Data_AppointmentEntity_SuperOffice_WebApi_RequestOptions_”></a> SaveAppointmentEntityAsync(AppointmentEntity, RequestOptions)
Updates the existing AppointmentEntity or creates a new AppointmentEntity if the id parameter is 0. Save the appointment entityParameters
appointmentEntity AppointmentEntity
The AppointmentEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> New or updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SaveAsync_SuperOffice_WebApi_Data_AppointmentEntity_SuperOffice_WebApi_Data_RecurrenceUpdateMode_System_Boolean_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_RequestOptions_”></a> SaveAsync(AppointmentEntity, RecurrenceUpdateMode, bool, EMailConnectionInfo, EMailConnectionInfo, RequestOptions)
Saving a booking.Parameters
appointmentEntity AppointmentEntity
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
sendEmailToParticipants bool
If true, emails will be sent to all participants that is marked with send email flag. If false no mails will be sent even if the send email flag is true.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
imapEMailConnectionInfo EMailConnectionInfo
Login information for imap server. Will be null if no login information is relevant.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentEntity> Updated AppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SaveSuggestedAppointmentEntityAsync_SuperOffice_WebApi_Data_SuggestedAppointmentEntity_SuperOffice_WebApi_RequestOptions_”></a> SaveSuggestedAppointmentEntityAsync(SuggestedAppointmentEntity, RequestOptions)
Updates the existing SuggestedAppointmentEntity or creates a new SuggestedAppointmentEntity if the id parameter is 0.Parameters
suggestedAppointmentEntity SuggestedAppointmentEntity
The SuggestedAppointmentEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SuggestedAppointmentEntity> New or updated SuggestedAppointmentEntity<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SaveTaskListItemAsync_SuperOffice_WebApi_Data_TaskListItem_SuperOffice_WebApi_RequestOptions_”></a> SaveTaskListItemAsync(TaskListItem, RequestOptions)
Updates the existing TaskListItem or creates a new TaskListItem if the id parameter is 0.Parameters
taskListItem TaskListItem
The TaskListItem that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskListItem> New or updated TaskListItem<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SaveWithCustomInvitationAsync_SuperOffice_WebApi_Data_AppointmentEntity_SuperOffice_WebApi_Data_RecurrenceUpdateMode_System_Boolean_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_Data_EMailConnectionInfo_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> SaveWithCustomInvitationAsync(AppointmentEntity, RecurrenceUpdateMode, bool, EMailConnectionInfo, EMailConnectionInfo, string, string, string, RequestOptions)
Save a booking and send a custom invitation email to participantsParameters
appointmentEntity AppointmentEntity
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
sendEmailToParticipants bool
If true, emails will be sent to all participants that is marked with send email flag. If false no mails will be sent even if the send email flag is true.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
imapEMailConnectionInfo EMailConnectionInfo
Login information for imap server. Will be null if no login information is relevant.
emailBody string
The email-body to be used for new invitations
subject string
The email-subject to be used for new invitations
templateLanguage string
The template language to use for invitation updates
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentSaveData> Appointment entity and flag for if email was queued to be sent<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SetActivityStatusAsync_System_String___SuperOffice_WebApi_Data_ActivityStatus_SuperOffice_WebApi_RequestOptions_”></a> SetActivityStatusAsync(string[], ActivityStatus, RequestOptions)
Sets the completed status for an array of activities. The string activityIdentifier param may contain of a mix of appointment_id, sale_id, document_id and todo_id. The changes are saved immediately. If an invalid id is passed in (nonexistent record), no changes will be made. If there is no write access to the record being changed, a Sentry exception will be thrown in the usual manner.Parameters
activityIdentifier string[]
Array of activity ids. ex. appointment_id=666
activityStatus ActivityStatus
The status to set the activities
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SetSeenAsync_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> SetSeenAsync(int, RecurrenceUpdateMode, RequestOptions)
Sets an appointment invitiation to seen.Parameters
appointmentId int
The appointmentId. Both master and child record ids are accepted.
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_SetSeenManyAsync_System_Int32___SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> SetSeenManyAsync(int[], RecurrenceUpdateMode, RequestOptions)
Sets a list of appointment invitations to seen. The same update mode will be used for all appointments in this batch.Parameters
appointmentIds int[]
List of appointment IDs
updateMode RecurrenceUpdateMode
Update mode for a recurring appointment.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ToggleActivitiesAsync_System_String___SuperOffice_WebApi_RequestOptions_”></a> ToggleActivitiesAsync(string[], RequestOptions)
Toggle the completed status for an array of activities.Parameters
activityIdentifier string[]
Contain of a mix of appointment_id, sale_id, document_id and todo_id.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ActivityStatus> The resulting ActivityStatus of the first in the array<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ToggleActivityAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> ToggleActivityAsync(string, RequestOptions)
Toggle the completed status for an activity. Activity may be sale, document or appointment. The changes are saved immediately.Parameters
activityIdentifier string
May contain of a mix of appointment_id, sale_id, document_id and todo_id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ActivityStatus> What the result after toggling was.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ToggleAndSetActivitiesAsync_System_String___SuperOffice_WebApi_RequestOptions_”></a> ToggleAndSetActivitiesAsync(string[], RequestOptions)
Toggles the first activity and sets the rest of the activities to the result of the first toggle. However, there are some special rules for appointments that trigger a suggested appointment when they are completed. If more than one appointment in the set of identifiers triggers a suggestion, we will not toggle those appointments. This rule is only active when changing the status of an appointment to complete. There must be more than one appointment that triggers such an event for this rule to take effect.Parameters
activityIdentifiers string[]
Array of activity ids. ex. appointment_id=666
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string[]> The identifiers that were not toggled.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ToggleAppointmentStatusAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> ToggleAppointmentStatusAsync(int, RequestOptions)
Sets an appointment’s status to Completed if the appointment had a different status, or sets the status to started if already set to completed.Parameters
appointmentId int
The appointment id.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AppointmentStatus> The new AppointmentStatus<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_UpdateAppointmentAsync_System_Int32_System_DateTime_System_DateTime_System_Int32_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> UpdateAppointmentAsync(int, DateTime, DateTime, int, int, int, RequestOptions)
Updates an appointment record.Parameters
id int
startTime DateTime
endTime DateTime
status int
type int
associateId int
The appointment owner’s id (associate id)
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_UpdateAppointmentFromIcsResponseAsync_System_String_System_Byte___SuperOffice_WebApi_RequestOptions_”></a> UpdateAppointmentFromIcsResponseAsync(string, byte[], RequestOptions)
Update the attendance to an appointment based on incoming ICS RSVPs.Parameters
emailAddress string
The email-address of the person responding to our meeting-request.
icsData byte[]
The iCal ICS RSVP-content in byte-form.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> True if successfull.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_UpdateAppointmentWithModeAndEmailAsync_System_Int32_System_DateTime_System_DateTime_SuperOffice_WebApi_Data_AppointmentStatus_SuperOffice_WebApi_Data_AppointmentType_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_System_Boolean_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_Data_EMailConnectionInfo_SuperOffice_WebApi_RequestOptions_”></a> UpdateAppointmentWithModeAndEmailAsync(int, DateTime, DateTime, AppointmentStatus, AppointmentType, int, RecurrenceUpdateMode, bool, EMailConnectionInfo, EMailConnectionInfo, RequestOptions)
Updates an appointment record, taking the given recurrence update mode into account, possibly sending notification emails.Parameters
id int
startTime DateTime
endTime DateTime
status AppointmentStatus
type AppointmentType
associateId int
The appointment owner’s id (associate id)
updateMode RecurrenceUpdateMode
Update mode for recurrence.
sendEmailToParticipants bool
If true, emails will be sent to all participants that is marked with send email flag if deemed necessary. If false no mails will be sent even if the send email flag is true.
smtpEMailConnectionInfo EMailConnectionInfo
Login information for outgoing smtp email server. Will be null if no login information is relevant.
imapEMailConnectionInfo EMailConnectionInfo
Login information for imap server. Will be null if no login information is relevant.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_UpdateAppointmentWithModeAsync_System_Int32_System_DateTime_System_DateTime_SuperOffice_WebApi_Data_AppointmentStatus_SuperOffice_WebApi_Data_AppointmentType_System_Int32_SuperOffice_WebApi_Data_RecurrenceUpdateMode_SuperOffice_WebApi_RequestOptions_”></a> UpdateAppointmentWithModeAsync(int, DateTime, DateTime, AppointmentStatus, AppointmentType, int, RecurrenceUpdateMode, RequestOptions)
Updates an appointment record, taking the given recurrence update mode into account.Parameters
id int
startTime DateTime
endTime DateTime
status AppointmentStatus
type AppointmentType
associateId int
The appointment owner’s id (associate id)
updateMode RecurrenceUpdateMode
Update mode for recurrence.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment><a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ValidateAppointmentEntityAsync_SuperOffice_WebApi_Data_AppointmentEntity_SuperOffice_WebApi_RequestOptions_”></a> ValidateAppointmentEntityAsync(AppointmentEntity, RequestOptions)
Check that entity is ready for saving.Parameters
appointmentEntity AppointmentEntity
Entity to be checked.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<StringDictionary> Error messages tagged by field.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_ValidateDaysAsync_SuperOffice_WebApi_Data_AppointmentEntity_System_DateTime___SuperOffice_WebApi_RequestOptions_”></a> ValidateDaysAsync(AppointmentEntity, DateTime[], RequestOptions)
Validates the set of dates to calculate any conflicts.Parameters
appointmentEntity AppointmentEntity
dates DateTime[]
The dates to validate.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RecurrenceDate[]> Array of RecurrenceDate object for each validated date.<a id=“SuperOffice_WebApi_Agents_IAppointmentAgent_WillSendEmailAsync_SuperOffice_WebApi_Data_AppointmentEntity_SuperOffice_WebApi_RequestOptions_”></a> WillSendEmailAsync(AppointmentEntity, RequestOptions)
Returns true if the changes will trigger email sending on Save, so you can inform the user.Parameters
appointment AppointmentEntity
The appointment carrier with changes made, before saving the changes.
requestOptions RequestOptions
Override language/culture codes on this request.