Class Appointment

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for Appointment. Simple read-only appointment data.

public class Appointment : Carrier

Inheritance

object ← Carrier ← Appointment

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 Appointment 123 using the WebApi client:

var configuration = new WebApiConfiguration(url);
var agent = new AppointmentAgent(configuration);
var appointment = agent.GetAppointment( 123 );

Constructors

Appointment()

Default constructor - defaults any enum props to 0.

public Appointment()

Properties

ActiveDate

The date to be used for searching & showing

public virtual DateTime ActiveDate { get; set; }

Property Value

DateTime

Agenda

The agenda of the appointment.

public virtual string Agenda { get; set; }

Property Value

string

AlarmLeadTime

Alarm lead time.

public virtual TimeSpan AlarmLeadTime { get; set; }

Property Value

TimeSpan

AppointmentId

Primary key

public virtual int AppointmentId { get; set; }

Property Value

int

AssignedBy

Who (last) assigned this appointment to associate_id?

public virtual int AssignedBy { get; set; }

Property Value

int

AssignedByFullName

The associate’s culture formatted fullname (firstname, middleName and lastname)

public virtual string AssignedByFullName { get; set; }

Property Value

string

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?

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

string

AssociateFullName

The owner of the appointment - the associate whose diary/checklist the appointment is in.

public virtual string AssociateFullName { get; set; }

Property Value

string

AssociateId

ID of associate whose diary the appointment is in, REQUIRED

public virtual int AssociateId { get; set; }

Property Value

int

AssociateName

The associate’s name

public virtual string AssociateName { get; set; }

Property Value

string

BookingType

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

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

Property Value

BookingType?

BookingType_String

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

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

Property Value

string

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?

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

string

ColorIndex

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

public virtual short ColorIndex { get; set; }

Property Value

short

Completed

The Completed state. NULL if unknown enum value.

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

Property Value

ActivityStatus?

Completed_String

The Completed state. Raw string enum value.

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

Property Value

string

ContactId

Contact ID of owning contact, may be 0

public virtual int ContactId { get; set; }

Property Value

int

ContactName

The contact associated with the appointment.

public virtual string ContactName { get; set; }

Property Value

string

CreatedBy

Who created the appointment. Associate name.

public virtual string CreatedBy { get; set; }

Property Value

string

CreatedByAssociateId

Id of the associate that created the appointment

public virtual int CreatedByAssociateId { get; set; }

Property Value

int

CreatedByFullName

Who created the appointment. Full name.

public virtual string CreatedByFullName { get; set; }

Property Value

string

CreatedDate

Appointment creation date

public virtual DateTime CreatedDate { get; set; }

Property Value

DateTime

Description

The appointment’s textbox; holds a descriptive text about the appointment. Filled out by the user.

public virtual string Description { get; set; }

Property Value

string

EndDate

Date + end time planned

public virtual DateTime EndDate { get; set; }

Property Value

DateTime

HasAlarm

Does this appointment have an alarm

public virtual bool HasAlarm { get; set; }

Property Value

bool

InternalNotes

Internal notes for the appointment.

public virtual string InternalNotes { get; set; }

Property Value

string

InvitationStatus

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

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

Property Value

InvitationStatus?

InvitationStatus_String

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

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

Property Value

string

IsAlldayEvent

True if all day event

public virtual bool IsAlldayEvent { get; set; }

Property Value

bool

IsBooking

True if this appointment is a booking.

public virtual bool IsBooking { get; set; }

Property Value

bool

IsBookingMain

True if this appointment is a booking and current associate is the owner. False if it is a booking and current associate is a participant.

public virtual bool IsBookingMain { get; set; }

Property Value

bool

IsFree

True if free, false if busy

public virtual bool IsFree { get; set; }

Property Value

bool

IsPublished

True if appointment have an entry in published table

public virtual bool IsPublished { get; set; }

Property Value

bool

IsRecurrence

True if the appointment is part of a recurring pattern.

public virtual bool IsRecurrence { get; set; }

Property Value

bool

JoinVideomeetUrl

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

public virtual string JoinVideomeetUrl { get; set; }

Property Value

string

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

string

MotherAssociateId

Associate/owner of the mother appointment

public virtual int MotherAssociateId { get; set; }

Property Value

int

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

OwnedExternally

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

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

Property Value

AppointmentExternalOwner?

OwnedExternally_String

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

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

Property Value

string

PersonFullName

The full name of the person this appointment belongs to.

public virtual string PersonFullName { get; set; }

Property Value

string

PersonId

Person ID of person the appointment is with, may be 0

public virtual int PersonId { get; set; }

Property Value

int

PreferredTZLocation

Preferred timezone location to use when displaying/editing this appointment

public virtual int PreferredTZLocation { get; set; }

Property Value

int

PriorityId

Link to priority list

public virtual int PriorityId { get; set; }

Property Value

int

PriorityName

Name of the appointments priority

public virtual string PriorityName { get; set; }

Property Value

string

Private

Obsolete, but still maintained field for appointment privacy; denormalization of visiblefor status NULL if unknown enum value.

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

Property Value

AppointmentPrivate?

Private_String

Obsolete, but still maintained field for appointment privacy; denormalization of visiblefor status Raw string enum value.

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

Property Value

string

ProjectId

ID of project referred to, may be 0

public virtual int ProjectId { get; set; }

Property Value

int

ProjectName

The name of the project this appointment belong to. Blank if no project is connected.

public virtual string ProjectName { get; set; }

Property Value

string

RecurringEndDate

public virtual DateTime RecurringEndDate { get; set; }

Property Value

DateTime

RecurringPattern

NULL if unknown enum value.

[JsonIgnore]
public RecurrencePattern? RecurringPattern { get; set; }

Property Value

RecurrencePattern?

RecurringPattern_String

Raw string enum value.

[JsonProperty("RecurringPattern")]
public string RecurringPattern_String { get; set; }

Property Value

string

RecurringStartDate

public virtual DateTime RecurringStartDate { get; set; }

Property Value

DateTime

RejectReason

Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here

public virtual string RejectReason { get; set; }

Property Value

string

SaleId

Owning sale, if any (may be 0)

public virtual int SaleId { get; set; }

Property Value

int

SaleName

Heading of Owning sale, if any. (may be blank)

public virtual string SaleName { get; set; }

Property Value

string

StartDate

date + start time planned

public virtual DateTime StartDate { get; set; }

Property Value

DateTime

Task

Task comprises the different types of activities, like “Phone call”, “Meeting” and so on.

public virtual string Task { get; set; }

Property Value

string

TaskId

Link to task list

public virtual int TaskId { get; set; }

Property Value

int

TaskType

The different task types of the appointment, if the activity is an appointment, task, phone. See the different types of appointments in the database manual. NULL if unknown enum value.

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

Property Value

TaskType?

TaskType_String

The different task types of the appointment, if the activity is an appointment, task, phone. See the different types of appointments in the database manual. Raw string enum value.

[JsonProperty("TaskType")]
public string TaskType_String { get; set; }

Property Value

string

Title

The title of the appointment.

public virtual string Title { get; set; }

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.

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

Property Value

AppointmentType?

Type_String

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

Property Value

string

​ Class Appointment

​Inheritance

​Inherited Members

​Examples

​Constructors

​ Appointment()

​Properties

​ ActiveDate

​Property Value

​ Agenda

​Property Value

​ AlarmLeadTime

​Property Value

​ AppointmentId

​Property Value

​ AssignedBy

​Property Value

​ AssignedByFullName

​Property Value

​ AssignmentStatus

​Property Value

​See Also

​ AssignmentStatus_String

​Property Value

​See Also

​ AssociateFullName

​Property Value

​ AssociateId

​Property Value

​ AssociateName

​Property Value

​ BookingType

​Property Value

​See Also

​ BookingType_String

​Property Value

​See Also

​ CautionWarning

​Property Value

​See Also

​ CautionWarning_String

​Property Value

​See Also

​ ColorIndex

​Property Value

​ Completed

​Property Value

​See Also

​ Completed_String

​Property Value

​See Also

​ ContactId

​Property Value

​ ContactName

​Property Value

​ CreatedBy

​Property Value

​ CreatedByAssociateId

​Property Value

​ CreatedByFullName

​Property Value

​ CreatedDate

​Property Value

​ Description

​Property Value

​ EndDate

​Property Value

​ HasAlarm

​Property Value

​ InternalNotes

​Property Value

​ InvitationStatus

​Property Value

​See Also

​ InvitationStatus_String

​Property Value

​See Also

​ IsAlldayEvent

​Property Value

​ IsBooking

Class Appointment

Inheritance

Inherited Members

Examples

Constructors

Appointment()

Properties

ActiveDate

Property Value

Agenda

Property Value

AlarmLeadTime

Property Value

AppointmentId

Property Value

AssignedBy

Property Value

AssignedByFullName

Property Value

AssignmentStatus

Property Value

See Also

AssignmentStatus_String

Property Value

See Also

AssociateFullName

Property Value

AssociateId

Property Value

AssociateName

Property Value

BookingType

Property Value

See Also

BookingType_String

Property Value

See Also

CautionWarning

Property Value

See Also

CautionWarning_String

Property Value

See Also

ColorIndex

Property Value

Completed

Property Value

See Also

Completed_String

Property Value

See Also

ContactId

Property Value

ContactName

Property Value

CreatedBy

Property Value

CreatedByAssociateId

Property Value

CreatedByFullName

Property Value

CreatedDate

Property Value

Description

Property Value

EndDate

Property Value

HasAlarm

Property Value

InternalNotes

Property Value

InvitationStatus

Property Value

See Also

InvitationStatus_String

Property Value

See Also

IsAlldayEvent

Property Value

IsBooking