Class Appointment

Simple read-only appointment data.

Carrier object for Appointment. Services for the Appointment Carrier is available from the Appointment Agent.
Inheritance
object
Appointment
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
public class Appointment : Carrier
Examples

Get Appointment 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new AppointmentAgent();
   var appointment = agent.GetAppointment( 123 );
}

Constructors

Appointment()

Default constructor

Declaration
public Appointment()
See Also

Properties

ActiveDate

The date to be used for searching & showing

Declaration
[DataMember]
public virtual DateTime ActiveDate { get; set; }
Property Value
Type Description
DateTime
See Also

Agenda

The agenda of the appointment.

Declaration
[DataMember]
public virtual string Agenda { get; set; }
Property Value
Type Description
string
See Also

AlarmLeadTime

Alarm lead time.

Declaration
[DataMember]
public virtual TimeSpan AlarmLeadTime { get; set; }
Property Value
Type Description
TimeSpan
See Also

AppointmentId

Primary key

Declaration
[DataMember]
public virtual int AppointmentId { get; set; }
Property Value
Type Description
int
See Also

AssignedBy

Who (last) assigned this appointment to associate_id?

Declaration
[DataMember]
public virtual int AssignedBy { get; set; }
Property Value
Type Description
int
See Also

AssignedByFullName

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

Declaration
[DataMember]
public virtual string AssignedByFullName { get; set; }
Property Value
Type Description
string
See Also

AssignmentStatus

Status if this appointment is in the process of being assigned to someone else

Declaration
[DataMember]
public virtual AssignmentStatus AssignmentStatus { get; set; }
Property Value
Type Description
AssignmentStatus
See Also

AssociateFullName

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

Declaration
[DataMember]
public virtual string AssociateFullName { get; set; }
Property Value
Type Description
string
See Also

AssociateId

ID of associate whose diary the appointment is in, REQUIRED

Declaration
[DataMember]
public virtual int AssociateId { get; set; }
Property Value
Type Description
int
See Also

AssociateName

The associate's name

Declaration
[DataMember]
public virtual string AssociateName { get; set; }
Property Value
Type Description
string
See Also

BookingType

The type of booking the appointment represents

Declaration
[DataMember]
public virtual BookingType BookingType { get; set; }
Property Value
Type Description
BookingType
See Also

CautionWarning

Status field to indicate appointments that have some sort of problem

Declaration
[DataMember]
public virtual AppointmentCautionWarning CautionWarning { get; set; }
Property Value
Type Description
AppointmentCautionWarning
See Also

ColorIndex

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

Declaration
[DataMember]
public virtual short ColorIndex { get; set; }
Property Value
Type Description
short
See Also

Completed

The Completed state.

Declaration
[DataMember]
public virtual ActivityStatus Completed { get; set; }
Property Value
Type Description
ActivityStatus
See Also

ContactId

Contact ID of owning contact, may be 0

Declaration
[DataMember]
public virtual int ContactId { get; set; }
Property Value
Type Description
int
See Also

ContactName

The contact associated with the appointment.

Declaration
[DataMember]
public virtual string ContactName { get; set; }
Property Value
Type Description
string
See Also

CreatedBy

Who created the appointment. Associate name.

Declaration
[DataMember]
public virtual string CreatedBy { get; set; }
Property Value
Type Description
string
See Also

CreatedByAssociateId

Id of the associate that created the appointment

Declaration
[DataMember]
public virtual int CreatedByAssociateId { get; set; }
Property Value
Type Description
int
See Also

CreatedByFullName

Who created the appointment. Full name.

Declaration
[DataMember]
public virtual string CreatedByFullName { get; set; }
Property Value
Type Description
string
See Also

CreatedDate

Appointment creation date

Declaration
[DataMember]
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

Description

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

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

EndDate

Date + end time planned

Declaration
[DataMember]
public virtual DateTime EndDate { get; set; }
Property Value
Type Description
DateTime
See Also

HasAlarm

Does this appointment have an alarm

Declaration
[DataMember]
public virtual bool HasAlarm { get; set; }
Property Value
Type Description
bool
See Also

InternalNotes

Internal notes for the appointment.

Declaration
[DataMember]
public virtual string InternalNotes { get; set; }
Property Value
Type Description
string
See Also

InvitationStatus

Status if this appointment represents an invitation

Declaration
[DataMember]
public virtual InvitationStatus InvitationStatus { get; set; }
Property Value
Type Description
InvitationStatus
See Also

IsAlldayEvent

True if all day event

Declaration
[DataMember]
public virtual bool IsAlldayEvent { get; set; }
Property Value
Type Description
bool
See Also

IsBooking

True if this appointment is a booking.

Declaration
[DataMember]
public virtual bool IsBooking { get; set; }
Property Value
Type Description
bool
See Also

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.

Declaration
[DataMember]
public virtual bool IsBookingMain { get; set; }
Property Value
Type Description
bool
See Also

IsFree

True if free, false if busy

Declaration
[DataMember]
public virtual bool IsFree { get; set; }
Property Value
Type Description
bool
See Also

IsPublished

True if appointment have an entry in published table

Declaration
[DataMember]
public virtual bool IsPublished { get; set; }
Property Value
Type Description
bool
See Also

IsRecurrence

True if the appointment is part of a recurring pattern.

Declaration
[DataMember]
public virtual bool IsRecurrence { get; set; }
Property Value
Type Description
bool
See Also

JoinVideomeetUrl

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

Declaration
[DataMember]
public virtual string JoinVideomeetUrl { get; set; }
Property Value
Type Description
string
See Also

Location

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

Declaration
[DataMember]
public virtual string Location { get; set; }
Property Value
Type Description
string
See Also

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

Declaration
[DataMember]
public virtual int MotherId { get; set; }
Property Value
Type Description
int
See Also

OwnedExternally

Set if an external system owns this appointment.

Declaration
[DataMember]
public virtual AppointmentExternalOwner OwnedExternally { get; set; }
Property Value
Type Description
AppointmentExternalOwner
See Also

PersonFullName

The full name of the person this appointment belongs to.

Declaration
[DataMember]
public virtual string PersonFullName { get; set; }
Property Value
Type Description
string
See Also

PersonId

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

Declaration
[DataMember]
public virtual int PersonId { get; set; }
Property Value
Type Description
int
See Also

PreferredTZLocation

Preferred timezone location to use when displaying/editing this appointment

Declaration
[DataMember]
public virtual int PreferredTZLocation { get; set; }
Property Value
Type Description
int
See Also

PriorityId

Link to priority list

Declaration
[DataMember]
public virtual int PriorityId { get; set; }
Property Value
Type Description
int
See Also

PriorityName

Name of the appointments priority

Declaration
[DataMember]
public virtual string PriorityName { get; set; }
Property Value
Type Description
string
See Also

Private

Obsolete, but still maintained field for appointment privacy; denormalization of visiblefor status

Declaration
[DataMember]
public virtual AppointmentPrivate Private { get; set; }
Property Value
Type Description
AppointmentPrivate
See Also

ProjectId

ID of project referred to, may be 0

Declaration
[DataMember]
public virtual int ProjectId { get; set; }
Property Value
Type Description
int
See Also

ProjectName

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

Declaration
[DataMember]
public virtual string ProjectName { get; set; }
Property Value
Type Description
string
See Also

RecurringEndDate

Simple read-only appointment data.

Carrier object for Appointment. Services for the Appointment Carrier is available from the Appointment Agent.
Declaration
[DataMember]
public virtual DateTime RecurringEndDate { get; set; }
Property Value
Type Description
DateTime
See Also

RecurringPattern

Simple read-only appointment data.

Carrier object for Appointment. Services for the Appointment Carrier is available from the Appointment Agent.
Declaration
[DataMember]
public virtual RecurrencePattern RecurringPattern { get; set; }
Property Value
Type Description
RecurrencePattern
See Also

RecurringStartDate

Simple read-only appointment data.

Carrier object for Appointment. Services for the Appointment Carrier is available from the Appointment Agent.
Declaration
[DataMember]
public virtual DateTime RecurringStartDate { get; set; }
Property Value
Type Description
DateTime
See Also

RejectReason

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

Declaration
[DataMember]
public virtual string RejectReason { get; set; }
Property Value
Type Description
string
See Also

SaleId

Owning sale, if any (may be 0)

Declaration
[DataMember]
public virtual int SaleId { get; set; }
Property Value
Type Description
int
See Also

SaleName

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

Declaration
[DataMember]
public virtual string SaleName { get; set; }
Property Value
Type Description
string
See Also

StartDate

date + start time planned

Declaration
[DataMember]
public virtual DateTime StartDate { get; set; }
Property Value
Type Description
DateTime
See Also

Task

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

Declaration
[DataMember]
public virtual string Task { get; set; }
Property Value
Type Description
string
See Also

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.

Declaration
[DataMember]
public virtual TaskType TaskType { get; set; }
Property Value
Type Description
TaskType
See Also

Title

The title of the appointment.

Declaration
[DataMember]
public virtual string Title { get; set; }
Property Value
Type Description
string
See Also

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.

Declaration
[DataMember]
public virtual AppointmentType Type { get; set; }
Property Value
Type Description
AppointmentType
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also