> ## 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.Agents.SelectionAgent

# \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent">\</a> Class SelectionAgent

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

Selections, entities, members and tasks

```csharp theme={null}
public class SelectionAgent : AgentBase, ISelectionAgent, IAgentBase, IDisposable
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[AgentBase](SuperOffice.WebApi.Agents.AgentBase.md) ←
[SelectionAgent](SuperOffice.WebApi.Agents.SelectionAgent.md)

#### Implements

[ISelectionAgent](SuperOffice.WebApi.Agents.ISelectionAgent.md),
[IAgentBase](SuperOffice.WebApi.Agents.IAgentBase.md),
[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)

#### Inherited Members

[AgentBase.\_json](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__json),
[AgentBase.\_binary](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__binary),
[AgentBase.\_config](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__config),
[AgentBase.\_client](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__client),
[AgentBase.\_disposeClient](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase__disposeClient),
[AgentBase.Merge(RequestOptions)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Merge_SuperOffice_WebApi_RequestOptions_),
[AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromStream_System_Net_Http_HttpMethod_System_String_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.ParseAuthorization(IAuthorization)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ParseAuthorization_SuperOffice_WebApi_Authorization_IAuthorization_),
[AgentBase.CancelRequest()](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_CancelRequest),
[AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_SendRequestObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_SendRequestObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_),
[AgentBase.SendRequest(HttpRequestMessage, RequestOptions)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_SendRequest_System_Net_Http_HttpRequestMessage_SuperOffice_WebApi_RequestOptions_),
[AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ThrowOnResponseErrorAsync_System_Net_Http_HttpRequestMessage_System_Net_Http_HttpResponseMessage_),
[AgentBase.ParseResponse\<T\&gt;(HttpResponseMessage)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ParseResponse__1_System_Net_Http_HttpResponseMessage_),
[AgentBase.Finally(RequestOptions)](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Finally_SuperOffice_WebApi_RequestOptions_),
[AgentBase.Dispose()](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Dispose),
[AgentBase.Configuration](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Configuration),
[AgentBase.Client](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_Client),
[AgentBase.HasRunningRequest](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_HasRunningRequest),
[AgentBase.ClientCancellationTokenSource](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ClientCancellationTokenSource),
[AgentBase.ProgressListener](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_ProgressListener),
[AgentBase.UploadProgressListener](SuperOffice.WebApi.Agents.AgentBase.md#SuperOffice_WebApi_Agents_AgentBase_UploadProgressListener),
[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)

## Examples

\<pre>\<code class="lang-csharp">using SuperOffice.WebApi;
using SuperOffice.WebApi.Agents;

var mySession = new WebApiOptions("[http://example.com/super/api](http://example.com/super/api)");
mySession.Authorization = new AuthorizationUsernamePassword("user", "pass");
using (SelectionAgent agent = new SelectionAgent(mySession))
\{
// call methods on agent here...
}\</code>\</pre>

## Constructors

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_\_ctor\_System\_Net\_Http\_HttpClient\_">\</a> SelectionAgent(HttpClient)

Constructor: Selections, entities, members and tasks

```csharp theme={null}
public SelectionAgent(HttpClient httpClient)
```

#### Parameters

`httpClient` [HttpClient](https://learn.microsoft.com/dotnet/api/system.net.http.httpclient)

Use this HTTP client instead of making own HttpClient instance.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_\_ctor\_SuperOffice\_WebApi\_WebApiOptions\_System\_Net\_Http\_HttpClient\_">\</a> SelectionAgent(WebApiOptions, HttpClient)

Constructor: Selections, entities, members and tasks

```csharp theme={null}
public SelectionAgent(WebApiOptions options, HttpClient httpClient = null)
```

#### Parameters

`options` [WebApiOptions](SuperOffice.WebApi.WebApiOptions.md)

Base URL and authentication values.

`httpClient` [HttpClient](https://learn.microsoft.com/dotnet/api/system.net.http.httpclient)

Optional: Use this HTTP client instead of making a new one.

## Methods

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_AddContactSelectionMembersAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_ContactPersonId\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddContactSelectionMembersAsync(int, ContactPersonId\[], RequestOptions)

Adds the collection of ContactPersonId as members to the static selection

```csharp theme={null}
public Task AddContactSelectionMembersAsync(int selectionId, ContactPersonId[] contactPersonIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection where to members will be added to.

`contactPersonIds` [ContactPersonId](SuperOffice.WebApi.Data.ContactPersonId.md)\[]

A collection of ContactPersonId to add to the selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_AddContactSelectionMembersFromSearchAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddContactSelectionMembersFromSearchAsync(int, string, RequestOptions)

Adds members to the selection from the search result.

```csharp theme={null}
public Task<int> AddContactSelectionMembersFromSearchAsync(int selectionId, string storageKey, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

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

Storage key to be interpreted by the restriction storage provider, when it fetches criteria for the search

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Number of members added

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_AddRemoveContactSelectionMemberInterestsAsync\_System\_Int32\_System\_Int32\_\_\_System\_Int32\_\_\_System\_Int32\_\_\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddRemoveContactSelectionMemberInterestsAsync(int, int\[], int\[], int\[], int\[], RequestOptions)

Adds or removes interests on companies and persons in a selection.

```csharp theme={null}
public Task AddRemoveContactSelectionMemberInterestsAsync(int selectionId, int[] addCompanyInterests, int[] removeCompanyInterests, int[] addContactInterests, int[] removeContactInterests, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add or remove interests members from.

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

Array of int containing the id's of the interests to add to the company.

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

Array of int containing the id's of the interests to remove from the company.

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

Array of int containing the id's of the interests to add to the contact.

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

Array of int containing the id's of the interests to remove from the contact.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_AddSelectionMembersAsync\_System\_Int32\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddSelectionMembersAsync(int, int\[], RequestOptions)

Add selection members to a static selection of type others than contacts.

```csharp theme={null}
public Task<int> AddSelectionMembersAsync(int selectionId, int[] ids, RequestOptions requestOptions = null)
```

#### Parameters

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

The selection id to add the members to.

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

Collection of ids to add to the selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Returns number of members added to the selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_AddSelectionMembersFromSearchAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> AddSelectionMembersFromSearchAsync(int, string, RequestOptions)

Adds members from the selection using the search result.

```csharp theme={null}
public Task<int> AddSelectionMembersFromSearchAsync(int selectionId, string storageKey, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

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

Storage key to be interpreted by the restriction storage provider, when it fetches criteria for the search

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Number of members added.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CopyContactSelectionMembersAsync\_System\_Int32\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CopyContactSelectionMembersAsync(int, int, RequestOptions)

Copy contact selection members from selection into an existing selection.

```csharp theme={null}
public Task CopyContactSelectionMembersAsync(int fromSelectionId, int toSelectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy members from.

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

The id of the selection to copy members to.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CopySelectionMembersAsync\_System\_Int32\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CopySelectionMembersAsync(int, int, RequestOptions)

Copy selection members from selection into an existing selection.

```csharp theme={null}
public Task CopySelectionMembersAsync(int fromSelectionId, int toSelectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy members from.

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

The id of the selection to copy members to.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateContactSelectionFromSelectionAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_Data\_SelectionType\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateContactSelectionFromSelectionAsync(int, string, SelectionType, bool, RequestOptions)

Creates a new selection based on selection members from an existing selection.

```csharp theme={null}
public Task<SelectionEntity> CreateContactSelectionFromSelectionAsync(int selectionId, string name, SelectionType targetSelectionType, bool copyMembers, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy members from.

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

The name of the new selection.

`targetSelectionType` [SelectionType](SuperOffice.WebApi.Data.SelectionType.md)

The type of ContactSelection to create. The type can be static or dynamic. If the original selection to copy from is static, the SelectionType can only be static. If the original selection is dynamic, both a static and dynamic selection can be created.

`copyMembers` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

If true, the members from the original selection will be added to the newly created selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateContactSelectionFromShadowSelectionAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateContactSelectionFromShadowSelectionAsync(int, string, RequestOptions)

Creates a new contact selection based on contact selection members from an existing shadow sale, appointment, project or document selection. The new selection will always be static even if the original selection is dynamic.

```csharp theme={null}
public Task<SelectionEntity> CreateContactSelectionFromShadowSelectionAsync(int selectionId, string name, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy members from.

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

The name of the new selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateDefaultBoardViewSettingsFromEntityTypeAsync\_SuperOffice\_WebApi\_Data\_BoardViewEntityType\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultBoardViewSettingsFromEntityTypeAsync(BoardViewEntityType, RequestOptions)

Creates a new carrier from the entity type given, with the right kind of properties, defaults set.

```csharp theme={null}
public Task<BoardViewSettingsBase> CreateDefaultBoardViewSettingsFromEntityTypeAsync(BoardViewEntityType entityType, RequestOptions requestOptions = null)
```

#### Parameters

`entityType` [BoardViewEntityType](SuperOffice.WebApi.Data.BoardViewEntityType.md)

Entity type to create settings for

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)\&gt;

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateDefaultSelectionEntityAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultSelectionEntityAsync(RequestOptions)

Set default values into a new SelectionEntity.
NetServer calculates default values on the entity, which is required when creating/storing a new instance

```csharp theme={null}
public Task<SelectionEntity> CreateDefaultSelectionEntityAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

A blank SelectionEntity

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateNewEntryAsync\_SuperOffice\_WebApi\_Data\_DuplicateEntry\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateNewEntryAsync(DuplicateEntry, RequestOptions)

Creates a new selection based on external duplicate

```csharp theme={null}
public Task<int> CreateNewEntryAsync(DuplicateEntry duplicate, RequestOptions requestOptions = null)
```

#### Parameters

`duplicate` [DuplicateEntry](SuperOffice.WebApi.Data.DuplicateEntry.md)

The duplicate to create a new entry based upon

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

The database identity of the newly created entry

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateSelectionEntityAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateSelectionEntityAsync(string, RequestOptions)

Create (but do not save) a new selection entity, for the current user and the given target table; other fields populated as by CreateDefaultSelectionEntity()

```csharp theme={null}
public Task<SelectionEntity> CreateSelectionEntityAsync(string targetTableName, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the target table, such as 'contact' or 'appointment'; any table for which Selection functionality is enabled

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

The new SelectionEntity, which has not yet been saved

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateSelectionFromSelectionAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_Data\_SelectionType\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateSelectionFromSelectionAsync(int, string, SelectionType, bool, RequestOptions)

Creates a new selection based on selection members from an existing selection.

```csharp theme={null}
public Task<SelectionEntity> CreateSelectionFromSelectionAsync(int selectionId, string name, SelectionType targetSelectionType, bool copyMembers, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to copy members from.

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

The name of the new selection.

`targetSelectionType` [SelectionType](SuperOffice.WebApi.Data.SelectionType.md)

The type of Selection to create. The type can be static or dynamic. If the original selection to copy from is static, the SelectionType can only be static. If the original selection is dynamic, both a static and dynamic selection can be created.

`copyMembers` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

If true, the members from the original selection will be added to the newly created selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateTemporaryContactSelectionAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateTemporaryContactSelectionAsync(RequestOptions)

Creates a temporary selection.

```csharp theme={null}
public Task<SelectionEntity> CreateTemporaryContactSelectionAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateTemporaryContactSelectionFromContactPersonIdsAsync\_SuperOffice\_WebApi\_Data\_ContactPersonId\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateTemporaryContactSelectionFromContactPersonIdsAsync(ContactPersonId\[], RequestOptions)

Creates a temporary selection with members from a collection of ContactPerson id's.

```csharp theme={null}
public Task<SelectionEntity> CreateTemporaryContactSelectionFromContactPersonIdsAsync(ContactPersonId[] contactPersonIds, RequestOptions requestOptions = null)
```

#### Parameters

`contactPersonIds` [ContactPersonId](SuperOffice.WebApi.Data.ContactPersonId.md)\[]

A collection of ContactPersonId to copy into the temporary contact selection as members.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateTemporaryContactSelectionFromSelectionMemberIdsAsync\_System\_Int32\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateTemporaryContactSelectionFromSelectionMemberIdsAsync(int, int\[], RequestOptions)

Creates a temporary selection with members from a collection of selectionmember id's.

```csharp theme={null}
public Task<SelectionEntity> CreateTemporaryContactSelectionFromSelectionMemberIdsAsync(int selectionId, int[] selectionMemberIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The selectionId the selectionmembers is a part of.

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

A collection of int ids to copy into the temporary contact selection as members.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_CreateTemporarySelectionFromIdsAsync\_System\_Int32\_\_\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateTemporarySelectionFromIdsAsync(int\[], int, RequestOptions)

Creates a temporary selection with members from a collection of entity id's.

```csharp theme={null}
public Task<SelectionEntity> CreateTemporarySelectionFromIdsAsync(int[] ids, int targetTableNumber, RequestOptions requestOptions = null)
```

#### Parameters

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

A collection of Ids to copy into the temporary selection as members. The ids are primary keys of entities defined by the targetTableNumber parameter.

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

The type of selection to create.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

Returns the newly created SelectionEntity.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_DeleteBoardViewSettingsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteBoardViewSettingsAsync(int, RequestOptions)

Delete BoardViewSettings

```csharp theme={null}
public Task DeleteBoardViewSettingsAsync(int boardViewSettingsId, RequestOptions requestOptions = null)
```

#### Parameters

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

Primary key of BoardViewSettings

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

This method has no return value

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_DeleteContactsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteContactsAsync(int, RequestOptions)

Deletes all contacts from a selection. If a contact does not have delete rights, it will be skipped.

```csharp theme={null}
public Task DeleteContactsAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

Id of the selection the delete operation will be performed.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_DeleteEntitiesAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteEntitiesAsync(int, RequestOptions)

Deletes all entities from a selection. If an entity does not have delete rights, it will be skipped.

```csharp theme={null}
public Task DeleteEntitiesAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

Id of the selection the delete operation will be performed.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_DeletePersonsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeletePersonsAsync(int, RequestOptions)

Deletes all persons from a selection. If a person does not have delete rights, it will be skipped.

```csharp theme={null}
public Task DeletePersonsAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

Id of the selection the delete operation will be performed.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_DeleteSelectionEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteSelectionEntityAsync(int, RequestOptions)

Deletes the SelectionEntity

```csharp theme={null}
public Task DeleteSelectionEntityAsync(int selectionEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the SelectionEntity

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

This method has no return value

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_EditContactSelectionMemberDetailsAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_SelectionMemberEditValues\_SuperOffice\_WebApi\_RequestOptions\_">\</a> EditContactSelectionMemberDetailsAsync(int, SelectionMemberEditValues, RequestOptions)

Edit company and contact details in a selection based on contents in selectionMemberEditValues.

```csharp theme={null}
public Task EditContactSelectionMemberDetailsAsync(int selectionId, SelectionMemberEditValues selectionMemberEditValues, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to edit members from.

`selectionMemberEditValues` [SelectionMemberEditValues](SuperOffice.WebApi.Data.SelectionMemberEditValues.md)

An object of \<see cref="SelectionMemberEditValues"/> describing what should be changed for companys and contacts.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_ExportSelectionMembersAsync\_System\_Int32\_System\_String\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> ExportSelectionMembersAsync(int, string, bool, RequestOptions)

ExportSelectionMembers will generate a string that is the result of substituting the template variables with values from selectionmembers.

```csharp theme={null}
public Task<byte[]> ExportSelectionMembersAsync(int selectionId, string templateName, bool useContacts, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to generate the exported file.

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

The templateName parameter is the relative path of a .sxf file template. The .sxf files can be found in \template or in the user folder of the so archive.

`useContacts` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

If the selection contains other members than contacts, setting this to true will export the contact archive of the selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[]\&gt;

Returns a unicode byte array with the file to export to the user.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_ExportSelectionMembersWithOrderByAsync\_System\_Int32\_System\_String\_System\_Boolean\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> ExportSelectionMembersWithOrderByAsync(int, string, bool, string, RequestOptions)

ExportSelectionMembers will generate a string that is the result of substituting the template variables with values from selectionmembers.

```csharp theme={null}
public Task<byte[]> ExportSelectionMembersWithOrderByAsync(int selectionId, string templateName, bool useContacts, string orderBy, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to generate the exported file.

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

The templateName parameter is the relative path of a .sxf file template. The .sxf files can be found in \template or in the user folder of the so archive.

`useContacts` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

If the selection contains other members than contacts, setting this to true will export the contact archive of the selection.

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

OrderBy. \<Column,OrderBySortType>

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[]\&gt;

Returns a unicode byte array with the file to export to the user.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GenerateFollowUpsAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_AppointmentEntity\_System\_Int32\_System\_Boolean\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GenerateFollowUpsAsync(int, AppointmentEntity, int, bool, bool, RequestOptions)

Generate follow-ups for members in the selection.

```csharp theme={null}
public Task GenerateFollowUpsAsync(int selectionId, AppointmentEntity appointmentEntity, int associateId, bool saveOnContactOwner, bool uniqueContact, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to generate the follow-ups for.

`appointmentEntity` [AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md)

The AppointmentEntity with information about the appointment.

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

The associate to save the appointments on. If saveOnContactOwner is true, this id will be ignored. Appointments wil be saved on current user if associateId = 0.

`saveOnContactOwner` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

If true, the appointments will be saved on contact owner (Our contact). This parameter will override associateId if true.

`uniqueContact` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

If true, only one appointment will be created for each contact.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetBoardViewSettingsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetBoardViewSettingsAsync(int, RequestOptions)

Get BoardViewSettings by ID

```csharp theme={null}
public Task<BoardViewSettingsBase> GetBoardViewSettingsAsync(int boardViewSettingsId, RequestOptions requestOptions = null)
```

#### Parameters

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

Primary key of BoardViewSettings

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)\&gt;

The settings, of appropriate sub type

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetBoardViewSettingsForSelectionAsync\_System\_Int32\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetBoardViewSettingsForSelectionAsync(int, int, RequestOptions)

Get BoardViewSettings by associate id and selection id

```csharp theme={null}
public Task<BoardViewSettingsBase> GetBoardViewSettingsForSelectionAsync(int associateId, int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

Id of associate

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

Id of selection

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)\&gt;

The settings, of appropriate sub type

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetDuplicateRulesAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDuplicateRulesAsync(RequestOptions)

Retrieve all available duplicate rules for selection

```csharp theme={null}
public Task<DuplicateRule[]> GetDuplicateRulesAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[DuplicateRule](SuperOffice.WebApi.Data.DuplicateRule.md)\[]\&gt;

All available duplicate rules

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetDuplicatesAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDuplicatesAsync(string, RequestOptions)

Get duplicates(exact or similar in the database) based on the name

```csharp theme={null}
public Task<DuplicateEntry[]> GetDuplicatesAsync(string name, RequestOptions requestOptions = null)
```

#### Parameters

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

Name used for lookup

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[DuplicateEntry](SuperOffice.WebApi.Data.DuplicateEntry.md)\[]\&gt;

Any records matching the specified name

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetDynamicSelectionCriteriaAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDynamicSelectionCriteriaAsync(int, RequestOptions)

Get the criteria for this dynamic selection.

```csharp theme={null}
public Task<ArchiveRestrictionInfo[]> GetDynamicSelectionCriteriaAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]\&gt;

Criteria defining the selection result. NULL if selection does not exist, or if this is not a dynamic selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetDynamicSelectionCriteriaGroupsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDynamicSelectionCriteriaGroupsAsync(int, RequestOptions)

Get the criteria for this dynamic selection. This call supports multiple criteria groups.

```csharp theme={null}
public Task<ArchiveRestrictionGroup[]> GetDynamicSelectionCriteriaGroupsAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveRestrictionGroup](SuperOffice.WebApi.Data.ArchiveRestrictionGroup.md)\[]\&gt;

Criteria groups defining the selection result. NULL if selection does not exist, or if this is not a dynamic selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetParentCombinedSelectionsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetParentCombinedSelectionsAsync(int, RequestOptions)

Get a list of all selection ids where the given selection is used to create a combined selection.

```csharp theme={null}
public Task<int[]> GetParentCombinedSelectionsAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The selectionId to query for.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\[]\&gt;

Array of selectionIds.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetRecipientStatisticsAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetRecipientStatisticsAsync(int, RequestOptions)

Returns a RecipientStatistics object with a count of addresses, emailaddresses and emailaddresses.

```csharp theme={null}
public Task<RecipientStatistics> GetRecipientStatisticsAsync(int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to get the statistics for.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[RecipientStatistics](SuperOffice.WebApi.Data.RecipientStatistics.md)\&gt;

Returns a RecipientStatistics object.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetRecipientStatisticsFromContactPersonIdsAsync\_SuperOffice\_WebApi\_Data\_ContactPersonId\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetRecipientStatisticsFromContactPersonIdsAsync(ContactPersonId\[], RequestOptions)

Returns a RecipientStatistics object with a count of addresses, emailaddresses and emailaddresses based on contact and persons in a collection of ContactPersonId.

```csharp theme={null}
public Task<RecipientStatistics> GetRecipientStatisticsFromContactPersonIdsAsync(ContactPersonId[] contactPersonIds, RequestOptions requestOptions = null)
```

#### Parameters

`contactPersonIds` [ContactPersonId](SuperOffice.WebApi.Data.ContactPersonId.md)\[]

A collection of ContactPersonId to get the statistics for.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[RecipientStatistics](SuperOffice.WebApi.Data.RecipientStatistics.md)\&gt;

Returns a RecipientStatistics object.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetRecipientStatisticsFromProjectMembersAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetRecipientStatisticsFromProjectMembersAsync(int, RequestOptions)

Returns a RecipientStatistics object with a count of addresses, emailaddresses and emailaddresses based on members in a project.

```csharp theme={null}
public Task<RecipientStatistics> GetRecipientStatisticsFromProjectMembersAsync(int projectId, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the project to get the member statistics for.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[RecipientStatistics](SuperOffice.WebApi.Data.RecipientStatistics.md)\&gt;

Returns a RecipientStatistics object.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetSelectionEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSelectionEntityAsync(int, RequestOptions)

Gets a specific SelectionEntity object.

```csharp theme={null}
public Task<SelectionEntity> GetSelectionEntityAsync(int selectionEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the SelectionEntity object

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

SelectionEntity

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetSelectionForFindAsync\_System\_String\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSelectionForFindAsync(string, int, RequestOptions)

Obtain a selection for the given entity, for the current user, of type WorkingSetForFind. Optionally populate criteria from the TypicalSearches system

```csharp theme={null}
public Task<SelectionForFind> GetSelectionForFindAsync(string entityName, int typicalSearchId, RequestOptions requestOptions = null)
```

#### Parameters

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

The name of the entity to make a selection for; examples 'sale', 'project', 'y\_equipment'

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

If 0, keep existing criteria; if -1, reset to entity default; > 0 get criteria from given TypicalSearch

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionForFind](SuperOffice.WebApi.Data.SelectionForFind.md)\&gt;

Target selection id and provider name

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetSelectionMembersArchiveRowsAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSelectionMembersArchiveRowsAsync(int, string, RequestOptions)

Get the list of members in this selection. The type of members depends on the target table of the selection.

```csharp theme={null}
public Task<ArchiveListItem[]> GetSelectionMembersArchiveRowsAsync(int selectionId, string select, RequestOptions requestOptions = null)
```

#### Parameters

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

The selectionId we want selection members for.

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

(optional) Comma separated Column names to include in result. List of columns varies depending on the selection's TargetTable. e.g. 'name', 'firstname', 'startTime'

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\&gt;

Array of archive rows, where each item represents one row of data (row level data + the requested columns). NULL if selection does not exist.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetSelectionShadowMembersArchiveRowsAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSelectionShadowMembersArchiveRowsAsync(int, string, RequestOptions)

Get the list of members in this selection's shadow (i.e. the list of contacts + persons referenced in the main selection).

```csharp theme={null}
public Task<ArchiveListItem[]> GetSelectionShadowMembersArchiveRowsAsync(int selectionId, string select, RequestOptions requestOptions = null)
```

#### Parameters

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

The selectionId we want selection members for.

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

(optional) Comma separated Column names to include in result. List of columns varies depending on the selection's TargetTable. e.g. 'name', 'firstname,name', 'startTime,firstname,name'

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveListItem](SuperOffice.WebApi.Data.ArchiveListItem.md)\[]\&gt;

Array of archive rows, where each item represents one row of data (row level data + the requested columns). NULL if selection does not exist.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_GetSelectionSummariesAsync\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSelectionSummariesAsync(int\[], RequestOptions)

Get an array of summaryitem for the given selections

```csharp theme={null}
public Task<SelectionSummaryItem[]> GetSelectionSummariesAsync(int[] selectionIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The selections to fetch summaries for

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionSummaryItem](SuperOffice.WebApi.Data.SelectionSummaryItem.md)\[]\&gt;

Summary items for the given id's, in no particular order

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_RemoveContactSelectionMembersAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_ContactPersonId\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveContactSelectionMembersAsync(int, ContactPersonId\[], RequestOptions)

Removes members from the selection as  specified in the collection of ContactPersonId.

```csharp theme={null}
public Task RemoveContactSelectionMembersAsync(int selectionId, ContactPersonId[] contactPersonIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection where to members will be removed.

`contactPersonIds` [ContactPersonId](SuperOffice.WebApi.Data.ContactPersonId.md)\[]

A collection of ContactPersonId to remove from the static selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_RemoveContactSelectionMembersFromIdsAsync\_System\_Int32\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveContactSelectionMembersFromIdsAsync(int, int\[], RequestOptions)

Removes members from the selection using a collection a selectionmember id's. Members can only be removed from single selection.

```csharp theme={null}
public Task RemoveContactSelectionMembersFromIdsAsync(int selectionId, int[] selectionMembersIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection where to members will be removed.

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

An array of selectionmember id's to remove from the selection.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_RemoveContactSelectionMembersFromSearchAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveContactSelectionMembersFromSearchAsync(int, string, RequestOptions)

Removes members from the selection using the search result.

```csharp theme={null}
public Task<int> RemoveContactSelectionMembersFromSearchAsync(int selectionId, string storageKey, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to remove members.

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

Storage key to be interpreted by the restriction storage provider, when it fetches criteria for the search.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Number of members removed

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_RemoveSelectionMembersAsync\_System\_Int32\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveSelectionMembersAsync(int, int\[], RequestOptions)

Removes members from the selection as  specified in the collection of entity ids. The ids are selection member ids (selection member primary key)

```csharp theme={null}
public Task RemoveSelectionMembersAsync(int selectionId, int[] selectionMemberIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection where to members will be removed.

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

Selection member primary keys

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_RemoveSelectionMembersByIdAsync\_System\_Int32\_System\_Int32\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveSelectionMembersByIdAsync(int, int\[], RequestOptions)

Removes members from the selection as specified in the collection of entity ids. The ids can be a collection of sale ids, or other supported types.

```csharp theme={null}
public Task RemoveSelectionMembersByIdAsync(int selectionId, int[] ids, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection where to members will be removed.

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

A collection of sale/project/contact ids to remove from the selection. The ids can be a collection of sale ids, or other supported types.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_RemoveSelectionMembersFromSearchAsync\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RemoveSelectionMembersFromSearchAsync(int, string, RequestOptions)

Removes members from the selection using the search result.

```csharp theme={null}
public Task<int> RemoveSelectionMembersFromSearchAsync(int selectionId, string storageKey, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to remove members.

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

Storage key to be interpreted by the restriction storage provider, when it fetches criteria for the search.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Number of members removed

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SaveBoardViewSettingsAsync\_SuperOffice\_WebApi\_Data\_BoardViewSettingsBase\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveBoardViewSettingsAsync(BoardViewSettingsBase, RequestOptions)

Save BoardViewSettings

```csharp theme={null}
public Task<BoardViewSettingsBase> SaveBoardViewSettingsAsync(BoardViewSettingsBase boardViewSettings, RequestOptions requestOptions = null)
```

#### Parameters

`boardViewSettings` [BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)

Typed BoardViewSettings carrier object

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)\&gt;

The settings, of appropriate sub type

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SaveBoardViewSettingsForSelectionAndAssociateAsync\_SuperOffice\_WebApi\_Data\_BoardViewSettingsBase\_System\_Int32\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveBoardViewSettingsForSelectionAndAssociateAsync(BoardViewSettingsBase, int, int, RequestOptions)

Save BoardViewSettings on the given selection/associate

```csharp theme={null}
public Task<BoardViewSettingsBase> SaveBoardViewSettingsForSelectionAndAssociateAsync(BoardViewSettingsBase boardViewSettings, int associateId, int selectionId, RequestOptions requestOptions = null)
```

#### Parameters

`boardViewSettings` [BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)

Typed BoardViewSettings carrier object

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

Id of associate

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

Id of selection

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[BoardViewSettingsBase](SuperOffice.WebApi.Data.BoardViewSettingsBase.md)\&gt;

The settings, of appropriate sub type

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SaveSelectionEntityAsync\_SuperOffice\_WebApi\_Data\_SelectionEntity\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveSelectionEntityAsync(SelectionEntity, RequestOptions)

Updates the existing SelectionEntity or creates a new SelectionEntity if the id parameter is 0.

```csharp theme={null}
public Task<SelectionEntity> SaveSelectionEntityAsync(SelectionEntity selectionEntity, RequestOptions requestOptions = null)
```

#### Parameters

`selectionEntity` [SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)

The SelectionEntity that is saved.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[SelectionEntity](SuperOffice.WebApi.Data.SelectionEntity.md)\&gt;

New or updated SelectionEntity

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SetDuplicateRulesStatusAsync\_SuperOffice\_WebApi\_Data\_DuplicateRule\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetDuplicateRulesStatusAsync(DuplicateRule\[], RequestOptions)

Set which duplicate rules should be active or not

```csharp theme={null}
public Task SetDuplicateRulesStatusAsync(DuplicateRule[] rules, RequestOptions requestOptions = null)
```

#### Parameters

`rules` [DuplicateRule](SuperOffice.WebApi.Data.DuplicateRule.md)\[]

Duplicate rules to update active status for

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SetDynamicSelectionCriteria2Async\_System\_Int32\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetDynamicSelectionCriteria2Async(int, string, RequestOptions)

Update the criteria for this dynamic selection using string. Criteria are parsed from the OData filter form: ''name startswith 'foo' and category in (1,2,3)''

```csharp theme={null}
public Task<ArchiveRestrictionInfo[]> SetDynamicSelectionCriteria2Async(int selectionId, string filter, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

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

Criteria defining the selection result in OData filter form: `category in (1,2,3) and name = 'foo'`

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]\&gt;

Criteria defining the selection result. NULL if this is not a dynamic selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SetDynamicSelectionCriteria3Async\_System\_Int32\_SuperOffice\_WebApi\_Data\_ArchiveRestrictionInfo\_\_\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetDynamicSelectionCriteria3Async(int, ArchiveRestrictionInfo\[], string, RequestOptions)

Update the criteria for this dynamic selection. Use criteria as either restriction objects or OData string format. Criteria are parsed from the OData filter form: ''name startswith 'foo' and category in (1,2,3)''

```csharp theme={null}
public Task<ArchiveRestrictionInfo[]> SetDynamicSelectionCriteria3Async(int selectionId, ArchiveRestrictionInfo[] criteria, string filter, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

`criteria` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]

Criteria defining the selection result. Pass NULL if using the filter string instead.

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

Criteria defining the selection result in OData filter form: `category in (1,2,3) and name = 'foo'`. Pass NULL or empty string '' if using the criteria objects.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]\&gt;

Criteria defining the selection result. NULL if this is not a dynamic selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SetDynamicSelectionCriteriaAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_ArchiveRestrictionInfo\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetDynamicSelectionCriteriaAsync(int, ArchiveRestrictionInfo\[], RequestOptions)

Update the criteria for this dynamic selection. Replaces existing criteria with the new values.

```csharp theme={null}
public Task<ArchiveRestrictionInfo[]> SetDynamicSelectionCriteriaAsync(int selectionId, ArchiveRestrictionInfo[] criteria, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

`criteria` [ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]

Criteria defining the selection result.

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]\&gt;

Criteria defining the selection result. NULL if this is not a dynamic selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_SetDynamicSelectionCriteriaGroupsAsync\_System\_Int32\_SuperOffice\_WebApi\_Data\_ArchiveRestrictionGroup\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetDynamicSelectionCriteriaGroupsAsync(int, ArchiveRestrictionGroup\[], RequestOptions)

Update the criteria for this dynamic selection. Replaces existing criteria with the new values. This call supports multiple criteria groups.

```csharp theme={null}
public Task<ArchiveRestrictionGroup[]> SetDynamicSelectionCriteriaGroupsAsync(int selectionId, ArchiveRestrictionGroup[] criteria, RequestOptions requestOptions = null)
```

#### Parameters

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

The id of the selection to add members

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

Criteria groups defining the selection result. Empty array is legal, simply means no criteria have been set

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[ArchiveRestrictionGroup](SuperOffice.WebApi.Data.ArchiveRestrictionGroup.md)\[]\&gt;

Criteria groups defining the selection result. NULL if this is not a dynamic selection.

### \<a id="SuperOffice\_WebApi\_Agents\_SelectionAgent\_UpdateTypicalSearchAsync\_SuperOffice\_WebApi\_Data\_TypicalSearches\_SuperOffice\_WebApi\_RequestOptions\_">\</a> UpdateTypicalSearchAsync(TypicalSearches, RequestOptions)

Update (import) TypicalSearch information in the database

```csharp theme={null}
public Task<string> UpdateTypicalSearchAsync(TypicalSearches searches, RequestOptions requestOptions = null)
```

#### Parameters

`searches` [TypicalSearches](SuperOffice.WebApi.Data.TypicalSearches.md)

TypicalSearch structures to import. If null, then the fileset is scanned for \*TypicalSearch.json files and those are imported instead

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

Message that can be shown to the user, summarizing what has been done, if anything.