<a id=“SuperOffice_WebApi_Data_AppointmentEntity”></a> Class AppointmentEntity

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_ActiveLinks”></a> ActiveLinks

Number of active links to sale, document, appointment.

public virtual int ActiveLinks { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Agenda”></a> Agenda

The agenda of the appointment.

public virtual string Agenda { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_AlarmLeadTime”></a> AlarmLeadTime

Alarm lead time.

public virtual TimeSpan AlarmLeadTime { get; set; }

Property Value

TimeSpan

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_AppointmentId”></a> AppointmentId

Primary key

public virtual int AppointmentId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_AssignedBy”></a> AssignedBy

Who assigned this appointment to this user? Whose diary did the appointment come from?

public virtual Associate AssignedBy { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus”></a> AssignmentStatus

Status if this appointment is in the process of being assigned to someone else NULL if unknown enum value.

[JsonIgnore]
public AssignmentStatus? AssignmentStatus { get; set; }

Property Value

AssignmentStatus?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus_String”></a> AssignmentStatus_String

Status if this appointment is in the process of being assigned to someone else Raw string enum value.

[JsonProperty("AssignmentStatus")]
public string AssignmentStatus_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Associate”></a> Associate

The owner of the appointment - the associate whose diary/checklist the appointment is in. <p>Use MDO List name “associate” to get list items.</p>

public virtual Associate Associate { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_BookingType”></a> BookingType

The type of booking the appointment represents NULL if unknown enum value.

[JsonIgnore]
public BookingType? BookingType { get; set; }

Property Value

BookingType?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_BookingType_String”></a> BookingType_String

The type of booking the appointment represents Raw string enum value.

[JsonProperty("BookingType")]
public string BookingType_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning”></a> CautionWarning

Status field to indicate appointments that have some sort of problem NULL if unknown enum value.

[JsonIgnore]
public AppointmentCautionWarning? CautionWarning { get; set; }

Property Value

AppointmentCautionWarning?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning_String”></a> CautionWarning_String

Status field to indicate appointments that have some sort of problem Raw string enum value.

[JsonProperty("CautionWarning")]
public string CautionWarning_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_CentralserviceVideomeetId”></a> CentralserviceVideomeetId

GUID for video meeting in central services – this is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox.

public virtual string CentralserviceVideomeetId { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_ColorIndex”></a> ColorIndex

Appointment colour, used only in Japanese versions. Western versions take colour from Task

public virtual short ColorIndex { get; set; }

Property Value

short

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Completed”></a> Completed

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set. NULL if unknown enum value.

[JsonIgnore]
public ActivityStatus? Completed { get; set; }

Property Value

ActivityStatus?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Completed_String”></a> Completed_String

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set. Raw string enum value.

[JsonProperty("Completed")]
public string Completed_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Contact”></a> Contact

The contact associated with the appointment. It may also be null if no contact is associated with the appointment. <p>Use MDO List name “contact_new” to get list items.</p>

public virtual Contact Contact { get; set; }

Property Value

Contact

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_CreatedBy”></a> CreatedBy

The associate that first created the appointment. The property is read-only.

public virtual Associate CreatedBy { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_CreatedDate”></a> CreatedDate

Registered date

public virtual DateTime CreatedDate { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_CustomFields”></a> CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual <xref href=“SuperOffice.WebApi.Data.AppointmentEntity.ExtraFields” data-throw-if-not-resolved=“false”></xref> and <xref href=“SuperOffice.WebApi.Data.AppointmentEntity.UserDefinedFields?text=UserDefinedFields” data-throw-if-not-resolved=“false”></xref> properties are deprecated in favor of this combined collection. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary CustomFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Extra field data</td><td class=“description”> [Extra field name]<p></p> Example: <pre><code class=“lang-csharp”>‘x_gorp’ = ‘[I:123]’</code></pre> </td></tr><tr><td class=“term”>User defined field data</td><td class=“description”> [Prog-id name]<p></p> Example: <pre><code class=“lang-csharp”>‘SuperOffice:1’ = ‘[I:123]’</code></pre><p></p> </td></tr></tbody></table>

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Description”></a> Description

Description of the appointment.

public virtual string Description { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_EndDate”></a> EndDate

Date + end time planned

public virtual DateTime EndDate { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_ExtraFields”></a> ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.AppointmentEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary ExtraFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Plug-in data</td><td class=“description”> [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType </td></tr><tr><td class=“term”>Foreign key data</td><td class=“description”> The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry </td></tr><tr><td class=“term”>User defined table data</td><td class=“description”> [Table name].[Field name] Example: Phunneling.AggregatedSales </td></tr><tr><td class=“term”>Other</td><td class=“description”> Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys). </td></tr></tbody></table>

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_HasAlarm”></a> HasAlarm

Does this appointment have an alarm

public virtual bool HasAlarm { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_HasConflict”></a> HasConflict

Does the appointment overlap with another appointment in the user’s diary?

public virtual bool HasConflict { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_InternalNotes”></a> InternalNotes

Internal notes for the appointment.

public virtual string InternalNotes { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_InvitationStatus”></a> InvitationStatus

Status if this appointment represents an invitation NULL if unknown enum value.

[JsonIgnore]
public InvitationStatus? InvitationStatus { get; set; }

Property Value

InvitationStatus?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_InvitationStatus_String”></a> InvitationStatus_String

Status if this appointment represents an invitation Raw string enum value.

[JsonProperty("InvitationStatus")]
public string InvitationStatus_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_InvitedPerson”></a> InvitedPerson

If the appointment is a booking, the invited persons may be your associates, but you are also able to invite contact persons from other companies to join your meeting. They do not receive an invitation, unless you send them one by email, but you can see in the appointment that persons other than your associates have been invited to a meeting. Each invited person will have an appointment slave record.

public virtual Person InvitedPerson { get; set; }

Property Value

Person

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_IsAlldayEvent”></a> IsAlldayEvent

True if all day event

public virtual bool IsAlldayEvent { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_IsFree”></a> IsFree

True if free, false if busy

public virtual bool IsFree { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_IsMileStone”></a> IsMileStone

Is this appointment a milestone?

public virtual bool IsMileStone { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_IsPublished”></a> IsPublished

Publication is published

public virtual bool IsPublished { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_JoinVideomeetUrl”></a> JoinVideomeetUrl

Blank when not a video meeting. Filled with Join Meeting URL when created.

public virtual string JoinVideomeetUrl { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_LagTime”></a> LagTime

as leadtime, but after the end - time blocked for travel etc.

public virtual TimeSpan LagTime { get; set; }

Property Value

TimeSpan

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_LeadTime”></a> LeadTime

Time blocked (minutes) BEFORE starttime

public virtual TimeSpan LeadTime { get; set; }

Property Value

TimeSpan

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Links”></a> Links

List of all elements linked to the appointment.

public virtual Link[] Links { get; set; }

Property Value

Link[]

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Location”></a> Location

Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here

public virtual string Location { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_MotherAssociate”></a> MotherAssociate

The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in. The mother appointment is the one identified by the mother_id. If the mother_id is 0 or the same as this appointment_id, then the master associate will be the same as the ‘ordinary’ associate.

public virtual Associate MotherAssociate { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_MotherId”></a> MotherId

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking

public virtual int MotherId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_OwnedExternally”></a> OwnedExternally

Set if an external system owns this appointment. NULL if unknown enum value.

[JsonIgnore]
public AppointmentExternalOwner? OwnedExternally { get; set; }

Property Value

AppointmentExternalOwner?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_OwnedExternally_String”></a> OwnedExternally_String

Set if an external system owns this appointment. Raw string enum value.

[JsonProperty("OwnedExternally")]
public string OwnedExternally_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Participants”></a> Participants

List of id’s of the participants to this appointment.

public virtual ParticipantInfo[] Participants { get; set; }

Property Value

ParticipantInfo[]

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Person”></a> Person

An appointment may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required. <p>Use MDO List name “person” to get list items.</p>

public virtual Person Person { get; set; }

Property Value

Person

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_PreferredTZLocation”></a> PreferredTZLocation

Appointments preferred timezone location.

public virtual int PreferredTZLocation { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_PreferredTZLocationData”></a> PreferredTZLocationData

Read-only timezone data for PreferredTZLocation.

public virtual TimeZoneData PreferredTZLocationData { get; set; }

Property Value

TimeZoneData

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Priority”></a> Priority

It’s possible to give appointments different priorities. All the different priority types are saved in the priority table, and edited from the Admin. Client. An appointment does not require a priority. <p>Use MDO List name “priority” to get list items.</p>

public virtual Priority Priority { get; set; }

Property Value

Priority

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Private”></a> Private

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual. NULL if unknown enum value.

[JsonIgnore]
public AppointmentPrivate? Private { get; set; }

Property Value

AppointmentPrivate?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Private_String”></a> Private_String

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual. Raw string enum value.

[JsonProperty("Private")]
public string Private_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Project”></a> Project

An appointment may also be connected to a project, so you see the appointment both on the company card, and on the project card. This does not mean however that a project is required. <p>Use MDO List name “project” to get list items.</p>

public virtual Project Project { get; set; }

Property Value

Project

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_PublishEventDate”></a> PublishEventDate

Publish event date

public virtual DateTime PublishEventDate { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_PublishFrom”></a> PublishFrom

Publication valid from (inclusive)

public virtual DateTime PublishFrom { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_PublishTo”></a> PublishTo

Publication valid to (inclusive)

public virtual DateTime PublishTo { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Recurrence”></a> Recurrence

The appointment recurrence.

public virtual RecurrenceInfo Recurrence { get; set; }

Property Value

RecurrenceInfo

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_RejectCounter”></a> RejectCounter

How many invitees have rejected this appointment

public virtual short RejectCounter { get; set; }

Property Value

short

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_RejectReason”></a> RejectReason

Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here <p>Use MDO List name “rejectReason” to get list items.</p>

public virtual string RejectReason { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Sale”></a> Sale

An appointment may also be connected to a sale, so you see the appointment on the company card, on the project card and on the sale card. This does not mean however that a sale is required. <p>Use MDO List name “sale” to get list items.</p>

public virtual Sale Sale { get; set; }

Property Value

Sale

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_StartDate”></a> StartDate

date + start time planned

public virtual DateTime StartDate { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_SuggestedAppointmentId”></a> SuggestedAppointmentId

Suggested guide item that this appointment is an instance of (Note: NOT VALID for document-type appointments, they have their own link)

public virtual int SuggestedAppointmentId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Task”></a> Task

Task comprises the different types of activities, like “Phone call”, “Meeting” and so on. <p>Use MDO List name “task” to get list items.</p>

public virtual TaskListItem Task { get; set; }

Property Value

TaskListItem

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Title”></a> Title

The title of the appointment.

public virtual string Title { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Type”></a> Type

The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it’s a document. See the different types of appointments in the database manual. NULL if unknown enum value.

[JsonIgnore]
public AppointmentType? Type { get; set; }

Property Value

AppointmentType?

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_Type_String”></a> Type_String

[JsonProperty("Type")]
public string Type_String { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_UpdatedBy”></a> UpdatedBy

The person that last updated the appointment.

public virtual Associate UpdatedBy { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_AppointmentEntity_UpdatedDate”></a> UpdatedDate

Updated date

public virtual DateTime UpdatedDate { get; set; }

Property Value