\var configuration = new WebApiConfiguration(url);
var agent = new AppointmentAgent(configuration);
var appointmentEntity = agent.GetAppointmentEntity( 123 );\\
## Remarks
Use \\"FindAppointment"\\
Participants: \\"Participants"\\ with restriction \\"appointmentRestrictionId eq " + id\\.
Links: \\"Links"\\ with restriction \\"sourceAppointmentRestrictionId eq " + id\\.
## Constructors
### \\ AppointmentEntity()
Default constructor - defaults any enum props to 0.
```csharp theme={null}
public AppointmentEntity()
```
## Properties
### \\ ActiveDate
The date to be used for searching & showing
```csharp theme={null}
public virtual DateTime ActiveDate { get; set; }
```
#### Property Value
[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)
### \\ ActiveLinks
Number of active links to sale, document, appointment.
```csharp theme={null}
public virtual int ActiveLinks { get; set; }
```
#### Property Value
[int](https://learn.microsoft.com/dotnet/api/system.int32)
### \\ Agenda
The agenda of the appointment.
```csharp theme={null}
public virtual string Agenda { get; set; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
### \\ AlarmLeadTime
Alarm lead time.
```csharp theme={null}
public virtual TimeSpan AlarmLeadTime { get; set; }
```
#### Property Value
[TimeSpan](https://learn.microsoft.com/dotnet/api/system.timespan)
### \\ AppointmentId
Primary key
```csharp theme={null}
public virtual int AppointmentId { get; set; }
```
#### Property Value
[int](https://learn.microsoft.com/dotnet/api/system.int32)
### \\ AssignedBy
Who assigned this appointment to this user? Whose diary did the appointment come from?
```csharp theme={null}
public virtual Associate AssignedBy { get; set; }
```
#### Property Value
[Associate](SuperOffice.WebApi.Data.Associate.md)
### \\ AssignmentStatus
Status if this appointment is in the process of being assigned to someone else
NULL if unknown enum value.
```csharp theme={null}
[JsonIgnore]
public AssignmentStatus? AssignmentStatus { get; set; }
```
#### Property Value
[AssignmentStatus](SuperOffice.WebApi.Data.AssignmentStatus.md)?
#### See Also
[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[AssignmentStatus\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus_String)
### \\ AssignmentStatus\_String
Status if this appointment is in the process of being assigned to someone else
Raw string enum value.
```csharp theme={null}
[JsonProperty("AssignmentStatus")]
public string AssignmentStatus_String { get; set; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
#### See Also
[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[AssignmentStatus](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus)
### \\ Associate
The owner of the appointment - the associate whose diary/checklist the appointment is in.
\Use MDO List name "associate" to get list items.\
```csharp theme={null} public virtual Associate Associate { get; set; } ``` #### Property Value [Associate](SuperOffice.WebApi.Data.Associate.md) ### \\ BookingType The type of booking the appointment represents NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public BookingType? BookingType { get; set; } ``` #### Property Value [BookingType](SuperOffice.WebApi.Data.BookingType.md)? #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[BookingType\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_BookingType_String) ### \\ BookingType\_String The type of booking the appointment represents Raw string enum value. ```csharp theme={null} [JsonProperty("BookingType")] public string BookingType_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[BookingType](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_BookingType) ### \\ CautionWarning Status field to indicate appointments that have some sort of problem NULL if unknown enum value. ```csharp theme={null} [JsonIgnore] public AppointmentCautionWarning? CautionWarning { get; set; } ``` #### Property Value [AppointmentCautionWarning](SuperOffice.WebApi.Data.AppointmentCautionWarning.md)? #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[CautionWarning\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning_String) ### \\ CautionWarning\_String Status field to indicate appointments that have some sort of problem Raw string enum value. ```csharp theme={null} [JsonProperty("CautionWarning")] public string CautionWarning_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[CautionWarning](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_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. ```csharp theme={null} public virtual string CentralserviceVideomeetId { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### \\ ColorIndex Appointment colour, used only in Japanese versions. Western versions take colour from Task ```csharp theme={null} public virtual short ColorIndex { get; set; } ``` #### Property Value [short](https://learn.microsoft.com/dotnet/api/system.int16) ### \\ 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. ```csharp theme={null} [JsonIgnore] public ActivityStatus? Completed { get; set; } ``` #### Property Value [ActivityStatus](SuperOffice.WebApi.Data.ActivityStatus.md)? #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Completed\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_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. ```csharp theme={null} [JsonProperty("Completed")] public string Completed_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Completed](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Completed) ### \\ Contact The contact associated with the appointment. It may also be null if no contact is associated with the appointment. \Use MDO List name "contact\_new" to get list items.\
```csharp theme={null} public virtual Contact Contact { get; set; } ``` #### Property Value [Contact](SuperOffice.WebApi.Data.Contact.md) ### \\ CreatedBy The associate that first created the appointment. The property is read-only. ```csharp theme={null} public virtual Associate CreatedBy { get; set; } ``` #### Property Value [Associate](SuperOffice.WebApi.Data.Associate.md) ### \\ CreatedDate Registered date ```csharp theme={null} public virtual DateTime CreatedDate { get; set; } ``` #### Property Value [DateTime](https://learn.microsoft.com/dotnet/api/system.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 \| Extra field data\ | \
\[Extra field name]\ \ Example: \\
\ | \
| User defined field data\ | \
\[Prog-id name]\ \ Example: \\\\ \ | \
| Plug-in data\ | \\[Plug-in name].\[Property name] Example: DocumentPlugin.DocumentType \ | \
| Foreign key data\ | \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 \ | \
| User defined table data\ | \\[Table name].\[Field name] Example: Phunneling.AggregatedSales \ | \
| Other\ | \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). \ | \
Use MDO List name "person" to get list items.\
```csharp theme={null} public virtual Person Person { get; set; } ``` #### Property Value [Person](SuperOffice.WebApi.Data.Person.md) ### \\ PreferredTZLocation Appointments preferred timezone location. ```csharp theme={null} public virtual int PreferredTZLocation { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### \\ PreferredTZLocationData Read-only timezone data for PreferredTZLocation. ```csharp theme={null} public virtual TimeZoneData PreferredTZLocationData { get; set; } ``` #### Property Value [TimeZoneData](SuperOffice.WebApi.Data.TimeZoneData.md) ### \\ 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. \Use MDO List name "priority" to get list items.\
```csharp theme={null} public virtual Priority Priority { get; set; } ``` #### Property Value [Priority](SuperOffice.WebApi.Data.Priority.md) ### \\ 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. ```csharp theme={null} [JsonIgnore] public AppointmentPrivate? Private { get; set; } ``` #### Property Value [AppointmentPrivate](SuperOffice.WebApi.Data.AppointmentPrivate.md)? #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Private\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_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. ```csharp theme={null} [JsonProperty("Private")] public string Private_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Private](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_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. \Use MDO List name "project" to get list items.\
```csharp theme={null} public virtual Project Project { get; set; } ``` #### Property Value [Project](SuperOffice.WebApi.Data.Project.md) ### \\ PublishEventDate Publish event date ```csharp theme={null} public virtual DateTime PublishEventDate { get; set; } ``` #### Property Value [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) ### \\ PublishFrom Publication valid from (inclusive) ```csharp theme={null} public virtual DateTime PublishFrom { get; set; } ``` #### Property Value [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) ### \\ PublishTo Publication valid to (inclusive) ```csharp theme={null} public virtual DateTime PublishTo { get; set; } ``` #### Property Value [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) ### \\ Recurrence The appointment recurrence. ```csharp theme={null} public virtual RecurrenceInfo Recurrence { get; set; } ``` #### Property Value [RecurrenceInfo](SuperOffice.WebApi.Data.RecurrenceInfo.md) ### \\ RejectCounter How many invitees have rejected this appointment ```csharp theme={null} public virtual short RejectCounter { get; set; } ``` #### Property Value [short](https://learn.microsoft.com/dotnet/api/system.int16) ### \\ RejectReason Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here \Use MDO List name "rejectReason" to get list items.\
```csharp theme={null} public virtual string RejectReason { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.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. \Use MDO List name "sale" to get list items.\
```csharp theme={null} public virtual Sale Sale { get; set; } ``` #### Property Value [Sale](SuperOffice.WebApi.Data.Sale.md) ### \\ StartDate date + start time planned ```csharp theme={null} public virtual DateTime StartDate { get; set; } ``` #### Property Value [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) ### \\ SuggestedAppointmentId Suggested guide item that this appointment is an instance of (Note: NOT VALID for document-type appointments, they have their own link) ```csharp theme={null} public virtual int SuggestedAppointmentId { get; set; } ``` #### Property Value [int](https://learn.microsoft.com/dotnet/api/system.int32) ### \\ Task Task comprises the different types of activities, like “Phone call”, “Meeting” and so on. \Use MDO List name "task" to get list items.\
```csharp theme={null} public virtual TaskListItem Task { get; set; } ``` #### Property Value [TaskListItem](SuperOffice.WebApi.Data.TaskListItem.md) ### \\ Title The title of the appointment. ```csharp theme={null} public virtual string Title { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.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. ```csharp theme={null} [JsonIgnore] public AppointmentType? Type { get; set; } ``` #### Property Value [AppointmentType](SuperOffice.WebApi.Data.AppointmentType.md)? #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Type\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_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. ```csharp theme={null} [JsonProperty("Type")] public string Type_String { get; set; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) #### See Also [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Type](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Type) ### \\ UpdatedBy The person that last updated the appointment. ```csharp theme={null} public virtual Associate UpdatedBy { get; set; } ``` #### Property Value [Associate](SuperOffice.WebApi.Data.Associate.md) ### \\ UpdatedDate Updated date ```csharp theme={null} public virtual DateTime UpdatedDate { get; set; } ``` #### Property Value [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) ### \\ UserDefinedFields Deprecated: Use \