Skip to main content

Class AppointmentEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for AppointmentEntity. Appointments appear in the diary, and have links to a Contact/Person and possibly a Project or Sale. They have start and end time+date.

Inheritance

objectCarrierAppointmentEntity

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get AppointmentEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new AppointmentAgent(configuration); var appointmentEntity = agent.GetAppointmentEntity( 123 );</code></pre>

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All AppointmentEntity: <pre><code class=“lang-csharp”>“FindAppointment”</code></pre> Participants: <pre><code class=“lang-csharp”>“Participants”</code></pre> with restriction <pre><code class=“lang-csharp”>“appointmentRestrictionId eq ” + id</code></pre>. Links: <pre><code class=“lang-csharp”>“Links”</code></pre> with restriction <pre><code class=“lang-csharp”>“sourceAppointmentRestrictionId eq ” + id</code></pre>.

Constructors

AppointmentEntity()

Default constructor - defaults any enum props to 0.

Properties

ActiveDate

The date to be used for searching & showing

Property Value

DateTime Number of active links to sale, document, appointment.

Property Value

int

Agenda

The agenda of the appointment.

Property Value

string

AlarmLeadTime

Alarm lead time.

Property Value

TimeSpan

AppointmentId

Primary key

Property Value

int

AssignedBy

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

Property Value

Associate

AssignmentStatus

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

Property Value

AssignmentStatus?

See Also

AppointmentEntity.AssignmentStatus_String

AssignmentStatus_String

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

Property Value

string

See Also

AppointmentEntity.AssignmentStatus

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>

Property Value

Associate

BookingType

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

Property Value

BookingType?

See Also

AppointmentEntity.BookingType_String

BookingType_String

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

Property Value

string

See Also

AppointmentEntity.BookingType

CautionWarning

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

Property Value

AppointmentCautionWarning?

See Also

AppointmentEntity.CautionWarning_String

CautionWarning_String

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

Property Value

string

See Also

AppointmentEntity.CautionWarning

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.

Property Value

string

ColorIndex

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

Property Value

short

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.

Property Value

ActivityStatus?

See Also

AppointmentEntity.Completed_String

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.

Property Value

string

See Also

AppointmentEntity.Completed

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>

Property Value

Contact

CreatedBy

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

Property Value

Associate

CreatedDate

Registered date

Property Value

DateTime

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]”.

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>

Description

Description of the appointment.

Property Value

string

EndDate

Date + end time planned

Property Value

DateTime

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]”.

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>

HasAlarm

Does this appointment have an alarm

Property Value

bool

HasConflict

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

Property Value

bool

InternalNotes

Internal notes for the appointment.

Property Value

string

InvitationStatus

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

Property Value

InvitationStatus?

See Also

AppointmentEntity.InvitationStatus_String

InvitationStatus_String

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

Property Value

string

See Also

AppointmentEntity.InvitationStatus

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.

Property Value

Person

IsAlldayEvent

True if all day event

Property Value

bool

IsFree

True if free, false if busy

Property Value

bool

IsMileStone

Is this appointment a milestone?

Property Value

bool

IsPublished

Publication is published

Property Value

bool

JoinVideomeetUrl

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

Property Value

string

LagTime

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

Property Value

TimeSpan

LeadTime

Time blocked (minutes) BEFORE starttime

Property Value

TimeSpan List of all elements linked to the appointment.

Property Value

Link[]

Location

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

Property Value

string

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.

Property Value

Associate

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

Property Value

int

OwnedExternally

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

Property Value

AppointmentExternalOwner?

See Also

AppointmentEntity.OwnedExternally_String

OwnedExternally_String

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

Property Value

string

See Also

AppointmentEntity.OwnedExternally

Participants

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

Property Value

ParticipantInfo[]

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>

Property Value

Person

PreferredTZLocation

Appointments preferred timezone location.

Property Value

int

PreferredTZLocationData

Read-only timezone data for PreferredTZLocation.

Property Value

TimeZoneData

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>

Property Value

Priority

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.

Property Value

AppointmentPrivate?

See Also

AppointmentEntity.Private_String

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.

Property Value

string

See Also

AppointmentEntity.Private

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>

Property Value

Project

PublishEventDate

Publish event date

Property Value

DateTime

PublishFrom

Publication valid from (inclusive)

Property Value

DateTime

PublishTo

Publication valid to (inclusive)

Property Value

DateTime

Recurrence

The appointment recurrence.

Property Value

RecurrenceInfo

RejectCounter

How many invitees have rejected this appointment

Property Value

short

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>

Property Value

string

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>

Property Value

Sale

StartDate

date + start time planned

Property Value

DateTime

SuggestedAppointmentId

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

Property Value

int

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>

Property Value

TaskListItem

Title

The title of the appointment.

Property Value

string

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.

Property Value

AppointmentType?

See Also

AppointmentEntity.Type_String

Type_String

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. Raw string enum value.

Property Value

string

See Also

AppointmentEntity.Type

UpdatedBy

The person that last updated the appointment.

Property Value

Associate

UpdatedDate

Updated date

Property Value

DateTime

UserDefinedFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.AppointmentEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format “SuperOffice:[UdefFieldIdentity]”, e.g. “SuperOffice:1234” The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

Property Value

StringDictionary

VisibleFor

The set of users or groups the record is visible for

Property Value

VisibleFor[]

See Also

AppointmentAgent, ArchiveAgent,