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

# SuperOffice.WebApi.Data.ModuleLicense

# <a id="SuperOffice_WebApi_Data_ModuleLicense" /> Class ModuleLicense

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

Carrier object for ModuleLicense.
Represents a single module license info.

```csharp theme={null}
public class ModuleLicense
```

#### Inheritance

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

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_ModuleLicense__ctor" /> ModuleLicense()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_ModuleLicense_AllowedUserType" /> AllowedUserType

Allowed associate type for user licenses: internal(0), external(4).
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[ModuleLicense](SuperOffice.WebApi.Data.ModuleLicense.md).[AllowedUserType\_String](SuperOffice.WebApi.Data.ModuleLicense.md#SuperOffice_WebApi_Data_ModuleLicense_AllowedUserType_String)

### <a id="SuperOffice_WebApi_Data_ModuleLicense_AllowedUserType_String" /> AllowedUserType\_String

Allowed associate type for user licenses: internal(0), external(4).
Raw string enum value.

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

#### Property Value

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

#### See Also

[ModuleLicense](SuperOffice.WebApi.Data.ModuleLicense.md).[AllowedUserType](SuperOffice.WebApi.Data.ModuleLicense.md#SuperOffice_WebApi_Data_ModuleLicense_AllowedUserType)

### <a id="SuperOffice_WebApi_Data_ModuleLicense_ExtraFlags" /> ExtraFlags

Unspecified extra flags of license, part of checksum. Value=1 means this a 'user plan'; such licenses cause the admin gui to switch to radiobutton view

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_ExtraInfo" /> ExtraInfo

Free field, can be used by the module owner (example: host domain, for eJournal). NOTE: For rows with extraFlags=1 this field contains the list of modules that this plan comprises

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_IsHidden" /> IsHidden

If true, then this module should not appear in GUI and is not assignable by users

```csharp theme={null}
public virtual bool IsHidden { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_LicenseType" /> LicenseType

Entire system, per database, or per associate
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[ModuleLicense](SuperOffice.WebApi.Data.ModuleLicense.md).[LicenseType\_String](SuperOffice.WebApi.Data.ModuleLicense.md#SuperOffice_WebApi_Data_ModuleLicense_LicenseType_String)

### <a id="SuperOffice_WebApi_Data_ModuleLicense_LicenseType_String" /> LicenseType\_String

Entire system, per database, or per associate
Raw string enum value.

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

#### Property Value

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

#### See Also

[ModuleLicense](SuperOffice.WebApi.Data.ModuleLicense.md).[LicenseType](SuperOffice.WebApi.Data.ModuleLicense.md#SuperOffice_WebApi_Data_ModuleLicense_LicenseType)

### <a id="SuperOffice_WebApi_Data_ModuleLicense_ModuleDescription" /> ModuleDescription

Human-readable description of module, shown in GUI, default language. Additional languages can be added to LocaleText, resource type 25

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_ModuleName" /> ModuleName

The name of the module, not visible in GUI but used in the code. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_ModuleTooltip" /> ModuleTooltip

Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language. Additional languages can be added to LocaleText, resource type 27

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_ModuleVersion" /> ModuleVersion

Version string for this module

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_NumberOfLicenses" /> NumberOfLicenses

Number of licenses purchased.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_OwnerName" /> OwnerName

The name of the module owner, not visible in GUI but used in the code. OwnerName SUPEROFFICE is reserved and may NEVER be used by partners. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_PrerequisiteModuleName" /> PrerequisiteModuleName

If set, specifies a module license needed before this license can be granted

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_Signature" /> Signature

Signature that verifies that this row is correctly transferred from SuperLicense

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_SortOrder" /> SortOrder

Ordering value - generated by SuperLicense and transferred here. Must be followed for signatures to be correct

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ModuleLicense_Unrestricted" /> Unrestricted

If true, then there is no licenseNumber limit on how many of these modules may be assigned

```csharp theme={null}
public virtual bool Unrestricted { get; set; }
```

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.ModuleLicenseLink](/en/api/reference/webapi/SuperOffice.WebApi.Data.ModuleLicenseLink.md)
- [SuperOffice.WebApi.Data.GrantedModuleLicense](/en/api/reference/webapi/SuperOffice.WebApi.Data.GrantedModuleLicense.md)
- [SuperOffice.WebApi.Data.ExtendedModuleLicense](/en/api/reference/webapi/SuperOffice.WebApi.Data.ExtendedModuleLicense.md)
- [SuperOffice.WebApi.Data.LicenseInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.LicenseInfo.md)
- [SuperOffice.WebApi.Data.LicenseType](/en/api/reference/webapi/SuperOffice.WebApi.Data.LicenseType.md)
- [SuperOffice.WebApi.Agents.LicenseAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.LicenseAgent.md)