> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.AlarmData

# <a id="SuperOffice_WebApi_Data_AlarmData" /> Class AlarmData

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for AlarmData.

```csharp theme={null}
public class AlarmData : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[AlarmData](SuperOffice.WebApi.Data.AlarmData.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_AlarmData__ctor" /> AlarmData()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public AlarmData()
```

## Properties

### <a id="SuperOffice_WebApi_Data_AlarmData_AlarmTime" /> AlarmTime

```csharp theme={null}
public virtual DateTime AlarmTime { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_AlarmData_AppointmentId" /> AppointmentId

Primary key

```csharp theme={null}
public virtual int AppointmentId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_AlarmData_AppointmentText" /> AppointmentText

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

```csharp theme={null}
public virtual string AppointmentText { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_AppointmentType" /> AppointmentType

where=no start time,note,docin, docout
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public AppointmentType? AppointmentType { get; set; }
```

#### Property Value

[AppointmentType](SuperOffice.WebApi.Data.AppointmentType.md)?

#### See Also

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[AppointmentType\_String](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_AppointmentType_String)

### <a id="SuperOffice_WebApi_Data_AlarmData_AppointmentType_String" /> AppointmentType\_String

where=no start time,note,docin, docout
Raw string enum value.

```csharp theme={null}
[JsonProperty("AppointmentType")]
public string AppointmentType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[AppointmentType](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_AppointmentType)

### <a id="SuperOffice_WebApi_Data_AlarmData_AssignmentStatus" /> 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

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[AssignmentStatus\_String](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_AssignmentStatus_String)

### <a id="SuperOffice_WebApi_Data_AlarmData_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

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[AssignmentStatus](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_AssignmentStatus)

### <a id="SuperOffice_WebApi_Data_AlarmData_BookingType" /> 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

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[BookingType\_String](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_BookingType_String)

### <a id="SuperOffice_WebApi_Data_AlarmData_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

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[BookingType](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_BookingType)

### <a id="SuperOffice_WebApi_Data_AlarmData_ContactDepartment" /> ContactDepartment

Department

```csharp theme={null}
public virtual string ContactDepartment { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_ContactFullName" /> ContactFullName

```csharp theme={null}
public virtual string ContactFullName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_ContactId" /> ContactId

Contact ID of owning contact, may be 0

```csharp theme={null}
public virtual int ContactId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_AlarmData_ContactName" /> ContactName

Contact name

```csharp theme={null}
public virtual string ContactName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_EndDate" /> EndDate

Date + end time planned

```csharp theme={null}
public virtual DateTime EndDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_AlarmData_FormalName" /> FormalName

The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs)

```csharp theme={null}
public virtual string FormalName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_InvitationStatus" /> InvitationStatus

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

```csharp theme={null}
[JsonIgnore]
public InvitationStatus? InvitationStatus { get; set; }
```

#### Property Value

[InvitationStatus](SuperOffice.WebApi.Data.InvitationStatus.md)?

#### See Also

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[InvitationStatus\_String](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_InvitationStatus_String)

### <a id="SuperOffice_WebApi_Data_AlarmData_InvitationStatus_String" /> InvitationStatus\_String

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

```csharp theme={null}
[JsonProperty("InvitationStatus")]
public string InvitationStatus_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[AlarmData](SuperOffice.WebApi.Data.AlarmData.md).[InvitationStatus](SuperOffice.WebApi.Data.AlarmData.md#SuperOffice_WebApi_Data_AlarmData_InvitationStatus)

### <a id="SuperOffice_WebApi_Data_AlarmData_JoinVideomeetUrl" /> JoinVideomeetUrl

```csharp theme={null}
public virtual string JoinVideomeetUrl { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_Location" /> Location

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

```csharp theme={null}
public virtual string Location { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_PersonFullName" /> PersonFullName

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

```csharp theme={null}
public virtual string PersonFullName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_PersonId" /> PersonId

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

```csharp theme={null}
public virtual int PersonId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_AlarmData_ProjectId" /> ProjectId

ID of project referred to, may be 0

```csharp theme={null}
public virtual int ProjectId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_AlarmData_ProjectName" /> ProjectName

Project name

```csharp theme={null}
public virtual string ProjectName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_SaleId" /> SaleId

Owning sale, if any (may be 0)

```csharp theme={null}
public virtual int SaleId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_AlarmData_SaleName" /> SaleName

```csharp theme={null}
public virtual string SaleName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_AlarmData_StartTime" /> StartTime

date + start time planned

```csharp theme={null}
public virtual DateTime StartTime { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_AlarmData_TaskName" /> TaskName

```csharp theme={null}
public virtual string TaskName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

## See Also

[AppointmentAgent](SuperOffice.WebApi.Agents.AppointmentAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.MultiAlarmData](/en/api/reference/webapi/SuperOffice.WebApi.Data.MultiAlarmData.md)
- [SuperOffice.WebApi.Data.Appointment GetAlarmsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetAlarmsRequest.md)
- [SuperOffice.WebApi.Data.Pocket RunAppointmentAlarmBrokerRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Pocket_RunAppointmentAlarmBrokerRequest.md)
- [SuperOffice.WebApi.Data.Appointment](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment.md)
- [SuperOffice.WebApi.Data.AppointmentSyncData](/en/api/reference/webapi/SuperOffice.WebApi.Data.AppointmentSyncData.md)
- [SuperOffice.WebApi.Data.AppointmentEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.AppointmentEntity.md)