> ## 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.TypicalSearch

# <a id="SuperOffice_WebApi_Data_TypicalSearch" /> Class TypicalSearch

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

Carrier object for TypicalSearch.
Complete information about a TypicalSearch (including criteria)

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[TypicalSearch](SuperOffice.WebApi.Data.TypicalSearch.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_TypicalSearch__ctor" /> TypicalSearch()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_TypicalSearch_EntityName" /> EntityName

The name of the entity the typical search links to

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_IncludePerson" /> IncludePerson

For selection-of-company: state of the Include Main Contact checkbox

```csharp theme={null}
public virtual short IncludePerson { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_IsEntityDefault" /> IsEntityDefault

Indicates if this is the default set of criteria for an entity

```csharp theme={null}
public virtual short IsEntityDefault { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_RestrictionGroups" /> RestrictionGroups

The restrictions (can be multiple groups) that make up the TypicalSearch

```csharp theme={null}
public virtual ArchiveRestrictionGroup[] RestrictionGroups { get; set; }
```

#### Property Value

[ArchiveRestrictionGroup](SuperOffice.WebApi.Data.ArchiveRestrictionGroup.md)\[]

### <a id="SuperOffice_WebApi_Data_TypicalSearch_Source" /> Source

Name of organisation that sources and maintains this TypicalSearch. Allows for both SuperOffice and partners to maintain sets of typical searches without conflict

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_Title" /> Title

The title of the typical search (multilingual)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_Tooltip" /> Tooltip

The tooltip for the typical search (multilingual)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_TypicalSearchId" /> TypicalSearchId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TypicalSearch_VersionNumber" /> VersionNumber

The current downloaded version of this typical search

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.TypicalSearches](/en/api/reference/webapi/SuperOffice.WebApi.Data.TypicalSearches.md)
- [SuperOffice.WebApi.Data.Selection UpdateTypicalSearchRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Selection_UpdateTypicalSearchRequest.md)
- [SuperOffice.WebApi.Agents.ISelectionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ISelectionAgent.md)
- [SuperOffice.WebApi.Agents.SelectionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.SelectionAgent.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.Selection](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.Selection.md)
- [SuperOffice.WebApi.Agents.DiagnosticsAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DiagnosticsAgent.md)