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

# \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent">\</a> Class ConfigurationAgent

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

User interface configuration - XMLs and other elements such as inter-client URLs

```csharp theme={null}
public class ConfigurationAgent : AgentBase, IConfigurationAgent, IAgentBase, IDisposable
```

#### Inheritance

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

#### Implements

[IConfigurationAgent](SuperOffice.WebApi.Agents.IConfigurationAgent.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 (ConfigurationAgent agent = new ConfigurationAgent(mySession))
\{
// call methods on agent here...
}\</code>\</pre>

## Constructors

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

Constructor: User interface configuration - XMLs and other elements such as inter-client URLs

```csharp theme={null}
public ConfigurationAgent(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\_ConfigurationAgent\_\_ctor\_SuperOffice\_WebApi\_WebApiOptions\_System\_Net\_Http\_HttpClient\_">\</a> ConfigurationAgent(WebApiOptions, HttpClient)

Constructor: User interface configuration - XMLs and other elements such as inter-client URLs

```csharp theme={null}
public ConfigurationAgent(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\_ConfigurationAgent\_ClearConfigurationCacheAsync\_System\_String\_System\_String\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> ClearConfigurationCacheAsync(string, string, bool, RequestOptions)

Configuration XML's may be expensive to build and parse, and are therefore cached to the database. \<para/>Cahcing is per application/instance/associate, and can be turned off through the config file. \<para/>If caching is on, and the configuration is changed, it is necessary to clear the cached configurations from the database, through this call.\<para/>Note that changes to the externalapplication table require cache invalidation. SoAdmin will do so automatically.

```csharp theme={null}
public Task ClearConfigurationCacheAsync(string application, string instance, bool forAllAssociates, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance 'SixWeb'

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

The instance name for the application, like 'MainInstance'

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

If false, only the current associate's configuration is cleared. If true, configurations are cleared for all associates.

`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)

There is no return value.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_CreateDefaultConfigurableScreenDeltaAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultConfigurableScreenDeltaAsync(RequestOptions)

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

```csharp theme={null}
public Task<ConfigurableScreenDelta> CreateDefaultConfigurableScreenDeltaAsync(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)\<[ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)\&gt;

A blank ConfigurableScreenDelta

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_CreateDefaultDiaryViewEntityAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultDiaryViewEntityAsync(RequestOptions)

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

```csharp theme={null}
public Task<DiaryViewEntity> CreateDefaultDiaryViewEntityAsync(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)\<[DiaryViewEntity](SuperOffice.WebApi.Data.DiaryViewEntity.md)\&gt;

A blank DiaryViewEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_CreateDefaultLandingPageEntityAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultLandingPageEntityAsync(RequestOptions)

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

```csharp theme={null}
public Task<LandingPageEntity> CreateDefaultLandingPageEntityAsync(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)\<[LandingPageEntity](SuperOffice.WebApi.Data.LandingPageEntity.md)\&gt;

A blank LandingPageEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_CreateDefaultSystemEventEntityAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> CreateDefaultSystemEventEntityAsync(RequestOptions)

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

```csharp theme={null}
public Task<SystemEventEntity> CreateDefaultSystemEventEntityAsync(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)\<[SystemEventEntity](SuperOffice.WebApi.Data.SystemEventEntity.md)\&gt;

A blank SystemEventEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_DeleteConfigurableScreenDeltaAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteConfigurableScreenDeltaAsync(int, RequestOptions)

Deletes the ConfigurableScreenDelta

```csharp theme={null}
public Task DeleteConfigurableScreenDeltaAsync(int configurableScreenDeltaId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the ConfigurableScreenDelta

`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\_ConfigurationAgent\_DeleteDiaryViewEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteDiaryViewEntityAsync(int, RequestOptions)

Deletes the DiaryViewEntity

```csharp theme={null}
public Task DeleteDiaryViewEntityAsync(int diaryViewEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the DiaryViewEntity

`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\_ConfigurationAgent\_DeleteLandingPageEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteLandingPageEntityAsync(int, RequestOptions)

Deletes the LandingPageEntity

```csharp theme={null}
public Task DeleteLandingPageEntityAsync(int landingPageEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the LandingPageEntity

`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\_ConfigurationAgent\_DeleteSystemEventEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteSystemEventEntityAsync(int, RequestOptions)

Deletes the SystemEventEntity

```csharp theme={null}
public Task DeleteSystemEventEntityAsync(int systemEventEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identity of the SystemEventEntity

`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\_ConfigurationAgent\_DeleteWindowPosSizeAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> DeleteWindowPosSizeAsync(int, RequestOptions)

Deletes a window and dialog position and size setting.

```csharp theme={null}
public Task DeleteWindowPosSizeAsync(int windowPosSizeId, RequestOptions requestOptions = null)
```

#### Parameters

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

Id of the window and dialog position and size settings item.

`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\_ConfigurationAgent\_ExistsSystemEventAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> ExistsSystemEventAsync(string, RequestOptions)

Is there a system event with the given key?

```csharp theme={null}
public Task<bool> ExistsSystemEventAsync(string key, RequestOptions requestOptions = null)
```

#### Parameters

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

The key to match on

`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)\<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)\&gt;

The system event

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetAllFeatureTogglesAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetAllFeatureTogglesAsync(RequestOptions)

Get all the feature toggles with their state (on/off)

```csharp theme={null}
public Task<StringBoolDictionary> GetAllFeatureTogglesAsync(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)\<[StringBoolDictionary](SuperOffice.WebApi.Data.StringBoolDictionary.md)\&gt;

The feature toggles with their state (on/off)

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetAnyConfigurationAsync\_System\_String\_System\_String\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetAnyConfigurationAsync(string, string, string, string, RequestOptions)

Get one defined configuration fragment, with full reference resolution and parsing applied. This is essentially the same service as the GetPageConfiguration, except that this service is not locked to objects of type Page.

```csharp theme={null}
public Task<string> GetAnyConfigurationAsync(string application, string instance, string item, string type, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance Six.Web

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

The instance name, for instance Main

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

The configuration item name (first component of file name)

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

The configuration item type (second component of file 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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

Fully resolved and parsed configuration XML, as string.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetApplicationConfigurationAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetApplicationConfigurationAsync(string, string, RequestOptions)

Return the application configuration. This is a list of pages, with information about the name, main panel and preference mappings of each page.

```csharp theme={null}
public Task<string> GetApplicationConfigurationAsync(string application, string instance, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance 'SixWeb'

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

The instance name for the application, like 'MainInstance'

`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;

XML structure containing the application configuration

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCRMUrlAsync\_System\_String\_System\_String\_System\_Boolean\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCRMUrlAsync(string, string, bool, RequestOptions)

Returns a valid url based in the soprotocol provided

```csharp theme={null}
public Task<string> GetCRMUrlAsync(string soProtocol, string currents, bool frameless, RequestOptions requestOptions = null)
```

#### Parameters

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

SoProtocol to display. Eg. contact.activityarchive.minipreview

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

currents to set. Eg. contact\_id=100\&person\_id=299

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

If true frame is not rendered( Navigationbar, buttonbar and menu )

`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;

Url with soprotocol

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCSAuthUrlAsync\_System\_String\_System\_String\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCSAuthUrlAsync(string, string, string, string, RequestOptions)

Will generate an url to the emarketing module

```csharp theme={null}
public Task<string> GetCSAuthUrlAsync(string language, string programName, string action, string extraParameters, RequestOptions requestOptions = null)
```

#### Parameters

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

By setting this parameter, you can change the CS language for the current user.

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

In this parameter you must specify which CS program you want to create an URL for. Valid examples are "ticket", "rms", "spm" etc.

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

Here you can optionally specify the action for the current program. This will enable you to go to a specific screen.

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

If an action is specified, you can specify extra parameters here. This can be used to set specific behaviour for the chosen screen/action. If an empty action is supplied, this parameter will be ignored.

`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;

Returns a valid CS URL composed of the give parameters.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCSRegistryValueAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCSRegistryValueAsync(int, RequestOptions)

This method will get a value from the CS Registry table.

```csharp theme={null}
public Task<string> GetCSRegistryValueAsync(int entry, RequestOptions requestOptions = null)
```

#### Parameters

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

The Registry entry to get

`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;

The value of the specified Registry entry

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCSWwwFolderAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCSWwwFolderAsync(RequestOptions)

This method will get the www folder for CS

```csharp theme={null}
public Task<string> GetCSWwwFolderAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

The www folder for CS

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetConfigurableScreenDeltaAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetConfigurableScreenDeltaAsync(int, RequestOptions)

Gets a specific ConfigurableScreenDelta object.

```csharp theme={null}
public Task<ConfigurableScreenDelta> GetConfigurableScreenDeltaAsync(int configurableScreenDeltaId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the ConfigurableScreenDelta 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)\<[ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)\&gt;

ConfigurableScreenDelta

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetConfigurableScreenDeltasByDeltaAsync\_SuperOffice\_WebApi\_Data\_ConfigurableScreenDelta\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetConfigurableScreenDeltasByDeltaAsync(ConfigurableScreenDelta, RequestOptions)

This method will return a configurablescreen delta matching the properties received from the incomming delta

```csharp theme={null}
public Task<ConfigurableScreenDelta[]> GetConfigurableScreenDeltasByDeltaAsync(ConfigurableScreenDelta configurableScreenDelta, RequestOptions requestOptions = null)
```

#### Parameters

`configurableScreenDelta` [ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)

A delta populated with wanted properties

`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)\<[ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)\[]\&gt;

An array of deltas matching the values of the incomming parameter-delta

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetConfigurableScreenDeltasByQueryAsync\_SuperOffice\_WebApi\_Data\_DeltaQuery\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetConfigurableScreenDeltasByQueryAsync(DeltaQuery, RequestOptions)

This method will return a configurablescreen delta matching the properties received from the incomming query

```csharp theme={null}
public Task<ConfigurableScreenDelta[]> GetConfigurableScreenDeltasByQueryAsync(DeltaQuery deltaQuery, RequestOptions requestOptions = null)
```

#### Parameters

`deltaQuery` [DeltaQuery](SuperOffice.WebApi.Data.DeltaQuery.md)

An object populated with wanted properties for the deltas to return

`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)\<[ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)\[]\&gt;

An array of deltas matching the values of the incomming query

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCsCgiUrlAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCsCgiUrlAsync(RequestOptions)

This method will get the host name for external CS

```csharp theme={null}
public Task<string> GetCsCgiUrlAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

Will get the host name for where CS Customer Center is installed

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCsCgiUrlInternalAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCsCgiUrlInternalAsync(RequestOptions)

This method will get the host name for CS

```csharp theme={null}
public Task<string> GetCsCgiUrlInternalAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

Will get the host name for where CS is installed

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCsProgramUrlAsync\_System\_String\_System\_String\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCsProgramUrlAsync(string, string, string, string, RequestOptions)

This method will convert a module name into a CS URL.

```csharp theme={null}
public Task<string> GetCsProgramUrlAsync(string language, string programName, string action, string extraParameters, RequestOptions requestOptions = null)
```

#### Parameters

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

By setting this parameter, you can change the CS language for the current user.

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

In this parameter you must specify which CS program you want to create an URL for. Valid examples are "ticket", "rms", "spm" etc.

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

Here you can optionally specify the action for the current program. This will enable you to go to a specific screen.

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

If an action is specified, you can specify extra parameters here. This can be used to set specific behaviour for the chosen screen/action. If an empty action is supplied, this parameter will be ignored.

`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;

Returns a valid CS URL composed of the give parameters.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetCustomerUrlAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetCustomerUrlAsync(RequestOptions)

This method will get the URL for the external access to the customer center

```csharp theme={null}
public Task<string> GetCustomerUrlAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

The URL to the customer center, without any actions

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetDiaryViewEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetDiaryViewEntityAsync(int, RequestOptions)

Gets a specific DiaryViewEntity object.

```csharp theme={null}
public Task<DiaryViewEntity> GetDiaryViewEntityAsync(int diaryViewEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the DiaryViewEntity 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)\<[DiaryViewEntity](SuperOffice.WebApi.Data.DiaryViewEntity.md)\&gt;

DiaryViewEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetEMarketingUrlAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetEMarketingUrlAsync(string, RequestOptions)

```csharp theme={null}
public Task<string> GetEMarketingUrlAsync(string language, RequestOptions requestOptions = null)
```

#### Parameters

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

`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;

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetEmailNumberOfDaysAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetEmailNumberOfDaysAsync(RequestOptions)

```csharp theme={null}
public Task<int> GetEmailNumberOfDaysAsync(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)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

Number of days in the past for which we are fetching email

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetFilterListAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetFilterListAsync(string, string, RequestOptions)

Get the list of filters to be used for processing the configuration data for this application.

```csharp theme={null}
public Task<string> GetFilterListAsync(string application, string instance, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance 'SixWeb'

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

The instance name for the application, like 'MainInstance'

`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;

XML representing the list of filters and any configuration data they may need.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetHelpDispatcherUrlAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetHelpDispatcherUrlAsync(RequestOptions)

Will get the GetHelpDispatcherUrl used by the help system

```csharp theme={null}
public Task<string> GetHelpDispatcherUrlAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

URL to be used by the help system

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

Get the landing page configuration for an associate and entity table. Creates the landing page row if it does not exist.

```csharp theme={null}
public Task<LandingPageEntity> GetLandingPageAsync(int associateId, string tableName, RequestOptions requestOptions = null)
```

#### Parameters

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

Id of the associate.

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

Entity table name (contact, person, sale, ...), transformed to and from the numeric table number by the service layer.

`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)\<[LandingPageEntity](SuperOffice.WebApi.Data.LandingPageEntity.md)\&gt;

The landing page for the given associate and entity table.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetLandingPageEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetLandingPageEntityAsync(int, RequestOptions)

Gets a specific LandingPageEntity object.

```csharp theme={null}
public Task<LandingPageEntity> GetLandingPageEntityAsync(int landingPageEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the LandingPageEntity 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)\<[LandingPageEntity](SuperOffice.WebApi.Data.LandingPageEntity.md)\&gt;

LandingPageEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetMyWindowPosSizesAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetMyWindowPosSizesAsync(RequestOptions)

Gets the window and dialog position and size settings belonging to the currently logged on user

```csharp theme={null}
public Task<WindowPosSize[]> GetMyWindowPosSizesAsync(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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\[]\&gt;

Array of window and dialog position and size settings

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetObjectMappingAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetObjectMappingAsync(string, string, RequestOptions)

Get the object mappings, i.e., the what code objects should be instantiated to handle the entities of the client configuration.

```csharp theme={null}
public Task<string> GetObjectMappingAsync(string application, string instance, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance 'SixWeb'

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

The instance name for the application, like 'MainInstance'

`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;

XML containing the object mappings, including assembly and class names

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetPageConfigurationAsync\_System\_String\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetPageConfigurationAsync(string, string, string, RequestOptions)

Get the configuration for one whole web page, including all its panels etc.  totally asynchronous items like menus are not included, but all references are resolved and all special processing is applied.

```csharp theme={null}
public Task<string> GetPageConfigurationAsync(string application, string instance, string page, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance 'SixWeb

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

The instance name for the application, like 'MainInstance'

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

Page name, must correspond to one of the pages in the Application Configuration

`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;

XML containing the configuration for the given page, from the page down to the control level.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetRecipeAppliesToMappingsAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetRecipeAppliesToMappingsAsync(RequestOptions)

Return the a  dictionary with recipeId as key, and chosen appliesTo for that recipe, Like projecttype for projectcardrecipe

```csharp theme={null}
public Task<StringDictionary> GetRecipeAppliesToMappingsAsync(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)\<[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)\&gt;

Mapping of recipeId and selected appliesToKey

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetRefreshedPageConfigurationAsync\_System\_String\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetRefreshedPageConfigurationAsync(string, string, string, RequestOptions)

Get the configuration for one whole web page, including all its panels etc.  totally asynchronous items like menus are not included, but all references are resolved and all special processing is applied. Does not use cache for fetching, but updates the cache with refreshed configuration.

```csharp theme={null}
public Task<string> GetRefreshedPageConfigurationAsync(string application, string instance, string page, RequestOptions requestOptions = null)
```

#### Parameters

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

The application name, for instance 'SixWeb

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

The instance name for the application, like 'MainInstance'

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

Page name, must correspond to one of the pages in the Application Configuration

`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;

XML containing the configuration for the given page, from the page down to the control level.

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetScreenConfigurationDeltaAsync\_SuperOffice\_WebApi\_Data\_DeltaType\_SuperOffice\_WebApi\_Data\_DeltaState\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetScreenConfigurationDeltaAsync(DeltaType, DeltaState, RequestOptions)

This method will return a json with all deltas for screen

```csharp theme={null}
public Task<string> GetScreenConfigurationDeltaAsync(DeltaType deltaType, DeltaState deltaState, RequestOptions requestOptions = null)
```

#### Parameters

`deltaType` [DeltaType](SuperOffice.WebApi.Data.DeltaType.md)

The recipe in json for this DeltaType: System, WebPanel, CustomFields, Custom...

`deltaState` [DeltaState](SuperOffice.WebApi.Data.DeltaState.md)

Draft or published or None

`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;

A string with recipe delta in json for logged in associate of given deltatype

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetScreenConfigurationDeltasAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetScreenConfigurationDeltasAsync(RequestOptions)

This method will return a json with all deltas for screen

```csharp theme={null}
public Task<string> GetScreenConfigurationDeltasAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

A string with all recipe deltas in json for logged in associate

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetSpfDomainAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSpfDomainAsync(RequestOptions)

Get the SPF domain defined for the mail cluster for this tenant (Online only)

```csharp theme={null}
public Task<string> GetSpfDomainAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

The configured SPF domain. Will return empty for Onsite installations or tenants in Online using custom SMTP

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetSystemEventEntityAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetSystemEventEntityAsync(int, RequestOptions)

Gets a specific SystemEventEntity object.

```csharp theme={null}
public Task<SystemEventEntity> GetSystemEventEntityAsync(int systemEventEntityId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the SystemEventEntity 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)\<[SystemEventEntity](SuperOffice.WebApi.Data.SystemEventEntity.md)\&gt;

SystemEventEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetWindowPosSizeAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetWindowPosSizeAsync(int, RequestOptions)

Gets a specific WindowPosSize object.

```csharp theme={null}
public Task<WindowPosSize> GetWindowPosSizeAsync(int windowPosSizeId, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifier of the WindowPosSize 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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\&gt;

WindowPosSize

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

Gets an array of specific WindowPosSize objects.

```csharp theme={null}
public Task<WindowPosSize[]> GetWindowPosSizeListAsync(int[] windowPosSizeIds, RequestOptions requestOptions = null)
```

#### Parameters

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

The identifiers of the WindowPosSize 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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\[]\&gt;

Array of WindowPosSize objects

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetWindowPosSizesOnAssociateIdAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetWindowPosSizesOnAssociateIdAsync(int, RequestOptions)

Gets the window and dialog position and size settings belonging to the specified associate

```csharp theme={null}
public Task<WindowPosSize[]> GetWindowPosSizesOnAssociateIdAsync(int associateId, RequestOptions requestOptions = null)
```

#### Parameters

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

Associate id of the Associate/Person owning these window settings

`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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\[]\&gt;

Array of window and dialog position and size settings

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetWindowPosSizesOnPersonIdAsync\_System\_Int32\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetWindowPosSizesOnPersonIdAsync(int, RequestOptions)

Gets the window and dialog position and size settings belonging to the specified person

```csharp theme={null}
public Task<WindowPosSize[]> GetWindowPosSizesOnPersonIdAsync(int personId, RequestOptions requestOptions = null)
```

#### Parameters

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

Person id of the associate owning these window settings

`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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\[]\&gt;

Array of window and dialog position and size settings

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetWwwUrlAsync\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetWwwUrlAsync(string, RequestOptions)

Will get the default URL used for the logo, from the \[NetServices] PageUrl preferencec, with tags substituted.

```csharp theme={null}
public Task<string> GetWwwUrlAsync(string client, RequestOptions requestOptions = null)
```

#### Parameters

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

The name for the client application, like 'CS' or 'SM.web', used for the \<clie> variable

`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;

URL to be used when clicking the logo

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_GetWwwUrlForSMWebAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetWwwUrlForSMWebAsync(RequestOptions)

Returns the URL used for the logo by the SM.web client. Uses urldispatch.aspx

```csharp theme={null}
public Task<string> GetWwwUrlForSMWebAsync(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)\<[string](https://learn.microsoft.com/dotnet/api/system.string)\&gt;

Link to urldispatch.aspx tagged with \[SOSITEURL]

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_RebuildCustomObjectArchivePanelDeltasAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RebuildCustomObjectArchivePanelDeltasAsync(RequestOptions)

Flush and rebuild CustomObjectArchivePanel deltas.

```csharp theme={null}
public Task RebuildCustomObjectArchivePanelDeltasAsync(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)

No return value

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_RebuildTaskMenuDeltasAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RebuildTaskMenuDeltasAsync(RequestOptions)

Flush and rebuild TaskMenu deltas.

```csharp theme={null}
public Task RebuildTaskMenuDeltasAsync(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)

No return value

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_RebuildUdefDeltasAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RebuildUdefDeltasAsync(RequestOptions)

Flush and rebuild userdefined field deltas. Mostly used after publishing udefs or adding/editing Customer Service extrafields

```csharp theme={null}
public Task RebuildUdefDeltasAsync(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)

No return value

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_RebuildWebpanelDeltasAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> RebuildWebpanelDeltasAsync(RequestOptions)

Flush and rebuild webpanel deltas. Mostly used after adding/editing webpanels or change group visibility of them

```csharp theme={null}
public Task RebuildWebpanelDeltasAsync(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)

No return value

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveAndPublishAsync\_SuperOffice\_WebApi\_Data\_ConfigurableScreenDelta\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveAndPublishAsync(ConfigurableScreenDelta, RequestOptions)

Save the incomming draft and publish

```csharp theme={null}
public Task<ConfigurableScreenDelta> SaveAndPublishAsync(ConfigurableScreenDelta configurableScreenDelta, RequestOptions requestOptions = null)
```

#### Parameters

`configurableScreenDelta` [ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)

The ConfigurableScreenDelta draft that is going to be published

`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)\<[ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)\&gt;

The newly published version of the ConfigurbleScreenDelta

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveConfigurableScreenDeltaAsync\_SuperOffice\_WebApi\_Data\_ConfigurableScreenDelta\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveConfigurableScreenDeltaAsync(ConfigurableScreenDelta, RequestOptions)

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

```csharp theme={null}
public Task<ConfigurableScreenDelta> SaveConfigurableScreenDeltaAsync(ConfigurableScreenDelta configurableScreenDelta, RequestOptions requestOptions = null)
```

#### Parameters

`configurableScreenDelta` [ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)

The ConfigurableScreenDelta 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)\<[ConfigurableScreenDelta](SuperOffice.WebApi.Data.ConfigurableScreenDelta.md)\&gt;

New or updated ConfigurableScreenDelta

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveDiaryViewEntityAsync\_SuperOffice\_WebApi\_Data\_DiaryViewEntity\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveDiaryViewEntityAsync(DiaryViewEntity, RequestOptions)

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

```csharp theme={null}
public Task<DiaryViewEntity> SaveDiaryViewEntityAsync(DiaryViewEntity diaryViewEntity, RequestOptions requestOptions = null)
```

#### Parameters

`diaryViewEntity` [DiaryViewEntity](SuperOffice.WebApi.Data.DiaryViewEntity.md)

The DiaryViewEntity 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)\<[DiaryViewEntity](SuperOffice.WebApi.Data.DiaryViewEntity.md)\&gt;

New or updated DiaryViewEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveLandingPageEntityAsync\_SuperOffice\_WebApi\_Data\_LandingPageEntity\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveLandingPageEntityAsync(LandingPageEntity, RequestOptions)

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

```csharp theme={null}
public Task<LandingPageEntity> SaveLandingPageEntityAsync(LandingPageEntity landingPageEntity, RequestOptions requestOptions = null)
```

#### Parameters

`landingPageEntity` [LandingPageEntity](SuperOffice.WebApi.Data.LandingPageEntity.md)

The LandingPageEntity 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)\<[LandingPageEntity](SuperOffice.WebApi.Data.LandingPageEntity.md)\&gt;

New or updated LandingPageEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveSystemEventEntityAsync\_SuperOffice\_WebApi\_Data\_SystemEventEntity\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveSystemEventEntityAsync(SystemEventEntity, RequestOptions)

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

```csharp theme={null}
public Task<SystemEventEntity> SaveSystemEventEntityAsync(SystemEventEntity systemEventEntity, RequestOptions requestOptions = null)
```

#### Parameters

`systemEventEntity` [SystemEventEntity](SuperOffice.WebApi.Data.SystemEventEntity.md)

The SystemEventEntity 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)\<[SystemEventEntity](SuperOffice.WebApi.Data.SystemEventEntity.md)\&gt;

New or updated SystemEventEntity

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveWindowPosSizeAsync\_SuperOffice\_WebApi\_Data\_WindowPosSize\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveWindowPosSizeAsync(WindowPosSize, RequestOptions)

Saves a window and dialog position and size setting.

```csharp theme={null}
public Task<WindowPosSize> SaveWindowPosSizeAsync(WindowPosSize windowPosSize, RequestOptions requestOptions = null)
```

#### Parameters

`windowPosSize` [WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)

The item 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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\&gt;

The saved item

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SaveWindowPosSizesAsync\_SuperOffice\_WebApi\_Data\_WindowPosSize\_\_\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SaveWindowPosSizesAsync(WindowPosSize\[], RequestOptions)

Saves a set of window and dialog position and size settings.

```csharp theme={null}
public Task<WindowPosSize[]> SaveWindowPosSizesAsync(WindowPosSize[] windowPosSizes, RequestOptions requestOptions = null)
```

#### Parameters

`windowPosSizes` [WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\[]

The items that are 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)\<[WindowPosSize](SuperOffice.WebApi.Data.WindowPosSize.md)\[]\&gt;

The saved items

### \<a id="SuperOffice\_WebApi\_Agents\_ConfigurationAgent\_SetAppliesToKeyAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> SetAppliesToKeyAsync(string, string, RequestOptions)

Set the type of assignTo the deltas of the given recipe should have

```csharp theme={null}
public Task SetAppliesToKeyAsync(string recipeId, string appliesToKey, RequestOptions requestOptions = null)
```

#### Parameters

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

The recipeId that will use this apply to type

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

The type we should use for differencing between delta layout. Like usergroup or project type. Saved in table ConfigurableScreenAppliesTo

`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)

Returns nothing

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

Pin or unpin an entity or selection on the landing page identified by associate and entity table. Creates the landing page row if it does not exist.

```csharp theme={null}
public Task SetLandingPagePinForAssociateAsync(bool pin, int associateId, string entityTableName, string pinTableName, int recordId, RequestOptions requestOptions = null)
```

#### Parameters

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

True to pin the item, false to unpin it.

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

Id of the associate that owns the landing page.

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

Entity table name identifying which landing page (contact, person, sale, ...).

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

Table name of the record being pinned (selection, contact, person, sale, ...).

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

Id of the record to pin or unpin.

`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