Mobile Service (MV10) Client Library
The client library allows consuming the service REST API.
Index
Service Client
| Class |
Description |
MobileClient |
The entry point of the Mobile Service client library. |
^ Back to top
Controllers
| Class |
Description |
Authorization |
Provides operations on authorization. |
Bogus |
Provides operations on bogus. |
Data |
Provides operations on data. |
Log |
Provides operations on log. |
Management |
Provides operations on management. |
OnPremHumanResources |
Provides operations on on prem human resources. |
Settings |
Provides operations on settings. |
The service includes custom operations not described here.
^ Back to top
Models
The service includes custom models not described here.
^ Back to top
Enumerations
The service includes custom enumerations not described here.
^ Back to top
Authorization Policies
| Policy |
Description |
Scope |
DefaultScope |
Defines an authorization policy that requires the default scope. |
lithium-mobile |
MobileWebUi |
Scope used for the mobile pages access. |
lithium-mobile-pages |
^ Back to top
Reference
Service Client
MobileClient
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
MobileClientBase (RestServiceClient)
Constructors
MobileClient(Uri, BearerTokenCredential)
| Parameter |
Type |
Description |
serviceUri |
Uri |
The service URI. |
credential |
BearerTokenCredential |
The credential that should be used to access the service. |
MobileClient(Uri, BearerTokenCredential, MobileClientOptions)
| Parameter |
Type |
Description |
serviceUri |
Uri |
The service URI. |
credential |
BearerTokenCredential |
The credential that should be used to access the service. |
clientOptions |
MobileClientOptions |
The client options. |
Example
Uri address = new Uri("[service-address]");
Uri authorizationServer = new Uri("[authorization-server]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"
MobileClient client = new MobileClient(
new Uri(address),
new ClientSecretCredential(
authorizationServer,
clientId,
clientSecret));
^ Back to top
Error Codes
ErrorCodes
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
Constants
| Constants |
Description |
Remarks |
AppMVConflict |
App MV Conflit error. |
|
AppMVNotFound |
Not found. |
|
InternalServerError |
An internal error occurred while processing your request. |
|
RequestArgsInvalid |
The request arguments are invalid. |
|
Controllers
AuthorizationClientController
Provides operations on authorization.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
AuthorizationClientControllerBase (IAuthorizationClientController)
Methods
CreateOrUpdateAuthorizationAsync()
Adds an user authorization.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> CreateOrUpdateAuthorizationAsync(string accountKey, string subscriptionAlias, System.Collections.Generic.IEnumerable<Cegid.Lithium.Mobile.Client.Rest.Models.UserAuthorization> authorizations, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
authorizations |
System.Collections.Generic.IEnumerable<Cegid.Lithium.Mobile.Client.Rest.Models.UserAuthorization> |
The authorizations. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
DeleteAuthorizationAsync()
Deletes an authorization.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAuthorizationAsync(string accountKey, string subscriptionAlias, string companyKey, string moduleKey, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
moduleKey |
string |
The module key. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
GetCompanyAuthorizationsAsync()
Gets the company authorizations.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.UserAuthorization>>> GetCompanyAuthorizationsAsync(string accountKey, string subscriptionAlias, string companyKey, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.UserAuthorization> |
Returns the company authorizations. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
BogusClientController
Provides operations on bogus.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
BogusClientControllerBase (IBogusClientController)
Methods
BogusUpdateAsync()
Bogus Action.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> BogusUpdateAsync(Cegid.Lithium.Mobile.Client.Rest.Models.Bogus bogusModel, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
bogusModel |
Cegid.Lithium.Mobile.Client.Rest.Models.Bogus |
The bogus model. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
DataClientController
Provides operations on data.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
DataClientControllerBase (IDataClientController)
Methods
UploadAsync()
Upload Data.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UploadAsync(string accountKey, string subscriptionAlias, string companyKey, string module, string entity, Cegid.Lithium.Mobile.Client.Rest.Models.Payload payload, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
module |
string |
The module. |
Required. |
entity |
string |
The entity. |
Required. |
payload |
Cegid.Lithium.Mobile.Client.Rest.Models.Payload |
The payload. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
LogClientController
Provides operations on log.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
LogClientControllerBase (ILogClientController)
Methods
HistoryAsync()
Gets the subscription company activity log history.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.LogRecord>>> HistoryAsync(string accountKey, string subscriptionAlias, string companyKey, int pageSize, int pageNumber, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
pageSize |
int |
The page size. |
Required.< 100. > 0. |
pageNumber |
int |
The page number. |
Required.> -1. |
Returns
| Return Type |
Description |
System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.LogRecord> |
Returns the subscription company activity log history. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.UnprocessableEntity |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
WriteAsync()
Adds message to the subscription log.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> WriteAsync(string accountKey, string subscriptionAlias, Cegid.Lithium.Mobile.Client.Rest.Models.LogRecord logRecord, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
logRecord |
Cegid.Lithium.Mobile.Client.Rest.Models.LogRecord |
The log record. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
ManagementClientController
Provides operations on management.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
ManagementClientControllerBase (IManagementClientController)
Methods
GetSusbscriptionAsync()
Gets the subscription information.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Mobile.Client.Rest.Models.Subscription>> GetSusbscriptionAsync(string accountKey, string subsAlias, string subscriptionAlias, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subsAlias |
string |
The subs alias. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
Returns
| Return Type |
Description |
Cegid.Lithium.Mobile.Client.Rest.Models.Subscription |
Returns the subscription information. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
RegisterEnterpriseAsync()
Register a subscription enterprise.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> RegisterEnterpriseAsync(string accountKey, string subsAlias, Cegid.Lithium.Mobile.Client.Rest.Models.Enterprise enterprise, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subsAlias |
string |
The subs alias. |
Required. |
enterprise |
Cegid.Lithium.Mobile.Client.Rest.Models.Enterprise |
The enterprise. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
RegisterSubscriptionAsync()
Registers a subscription.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> RegisterSubscriptionAsync(string accountKey, string subsAlias, Cegid.Lithium.Mobile.Client.Rest.Models.Subscription subscription, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subsAlias |
string |
The subs alias. |
Required. |
subscription |
Cegid.Lithium.Mobile.Client.Rest.Models.Subscription |
The subscription. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
OnPremHumanResourcesClientController
Provides operations on on prem human resources.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
OnPremHumanResourcesClientControllerBase (IOnPremHumanResourcesClientController)
Methods
GetEmployeeDocsSignaturesAsync()
Gets All Employee Documents Signatures.
- Authorization Policy:
DefaultScope
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.DocumentSignature>>> GetEmployeeDocsSignaturesAsync(string accountKey, string subscriptionAlias, string companyKey, string employeeKey, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
employeeKey |
string |
The employee key. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.DocumentSignature> |
Returns All Employee Documents Signatures. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
SettingsClientController
Provides operations on settings.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest
- Inheritance:
SettingsClientControllerBase (ISettingsClientController)
Methods
GetSettingByKeyAsync()
Get's a company setting by setting key.
- Authorization Policy:
MobileWebUi
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Mobile.Client.Rest.Models.Settings>> GetSettingByKeyAsync(string accountKey, string subscriptionAlias, string companyKey, string settingKey, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
settingKey |
string |
The setting key. |
Required. |
Returns
| Return Type |
Description |
Cegid.Lithium.Mobile.Client.Rest.Models.Settings |
Returns a company setting by setting key. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
GetSettingsAsync()
Gets the subscription company settings.
- Authorization Policy:
MobileWebUi
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.Settings>>> GetSettingsAsync(string accountKey, string subscriptionAlias, string companyKey, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.Settings> |
Returns the subscription company settings. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
PostSettingsAsync()
Stores the subscription company settings.
- Authorization Policy:
MobileWebUi
public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> PostSettingsAsync(string accountKey, string subscriptionAlias, string companyKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.Mobile.Client.Rest.Models.Settings> settings, CancellationToken cancellationToken = default);
Parameters
| Parameter |
Type |
Description |
Rules |
accountKey |
string |
The account key. |
Required. |
subscriptionAlias |
string |
The subscription alias. |
Required. |
companyKey |
string |
The company key. |
Required. |
settings |
System.Collections.Generic.IEnumerable<Cegid.Lithium.Mobile.Client.Rest.Models.Settings> |
The settings. |
Required. |
Returns
| Return Type |
Description |
| None |
The operation has no return value. |
Status Codes
| Status Code |
Description |
HttpStatusCode.OK |
Success. |
HttpStatusCode.BadRequest |
Failure: the request is invalid. |
HttpStatusCode.NotFound |
Failure: not found. |
HttpStatusCode.Conflict |
Failure: conflict. |
The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.
^ Back to top
Models
Bogus
Describes a bogus.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
BogusBase
Properties
| Property |
Type |
Description |
Rules |
MobileUser |
Cegid.Lithium.Mobile.Client.Rest.Models.MobileUser |
Gets or sets the mobile user. |
Required. |
Modules |
Cegid.Lithium.Mobile.Client.Rest.Models.Modules |
Gets or sets the modules. |
Required. |
^ Back to top
Data
Describes a data.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
DataBase
Properties
| Property |
Type |
Description |
Rules |
Id |
string |
Gets or sets the identifier. |
Required. |
SearchField |
string |
Gets or sets the search field. |
Required. |
BlobLink |
string |
Gets or sets the blob link. |
Required. |
^ Back to top
DocumentSignature
Describes a document signature.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
DocumentSignatureBase
Properties
| Property |
Type |
Description |
Rules |
Type |
string |
Gets or sets the type. |
Required. |
Signature |
string |
Gets or sets the signature. |
Required. |
Year |
string |
Gets or sets the year. |
Required. |
Month |
string |
Gets or sets the month. |
Required. |
^ Back to top
Enterprise
Describes an enterprise.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
EnterpriseBase
Properties
| Property |
Type |
Description |
Rules |
Id |
string |
Gets or sets the identifier. |
Required. |
SubscriptionAlias |
string |
Gets or sets the subscription alias. |
Required. |
Instance |
string |
Gets or sets the instance. |
Required. |
Code |
string |
Gets or sets the code. |
Required. |
Description |
string |
Gets or sets the description. |
Required. |
Active |
bool |
If true is active otherwise is not. |
Required. |
Settings |
System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.Settings>? |
Gets or sets the settings. |
|
^ Back to top
LogRecord
Describes a log record.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
LogRecordBase
Properties
| Property |
Type |
Description |
Rules |
Id |
string? |
Gets or sets the identifier. |
|
CompanyKey |
string? |
Gets or sets the company key. |
|
Timestamp |
System.DateTime |
Gets or sets the timestamp. |
Required. |
Message |
string |
Gets or sets the message. |
Required. |
Level |
Cegid.Lithium.Mobile.Client.Rest.Models.LogLevel |
Gets or sets the level. |
Required. |
^ Back to top
MobileUser
Describes a mobile user.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
MobileUserBase
Properties
| Property |
Type |
Description |
Rules |
Id |
string? |
Gets or sets the identifier. |
|
Email |
string |
Gets or sets the email. |
Required. |
Name |
string? |
Gets or sets the name. |
|
LastAccess |
System.DateTime? |
Gets or sets the last access. |
|
Subscriptions |
System.Collections.Generic.IList<string> |
Gets or sets the subscriptions. |
Required.Not empty. |
The model includes custom properties not described here.
^ Back to top
ModulePin
Describes a module pin.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
ModulePinBase
Properties
| Property |
Type |
Description |
Rules |
UserId |
string |
Gets or sets the user identifier. |
Required. |
ModuleId |
string |
Gets or sets the module identifier. |
Required. |
Hash |
string |
Gets or sets the hash. |
Required. |
Salt |
string |
Gets or sets the salt. |
Required. |
ResetCode |
string? |
Gets or sets the reset code. |
|
^ Back to top
Payload
Describes a payload.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
PayloadBase
Properties
| Property |
Type |
Description |
Rules |
Data |
string |
Gets or sets the data. |
Required. |
^ Back to top
Settings
Describes a settings.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
SettingsBase
Properties
| Property |
Type |
Description |
Rules |
SubscriptionAlias |
string |
Gets or sets the subscription alias. |
Required. |
Id |
string? |
Gets or sets the identifier. |
|
CompanyKey |
string? |
Gets or sets the company key. |
|
Key |
string |
Gets or sets the key. |
Required. |
Value |
string |
Gets or sets the value. |
Required. |
^ Back to top
Subscription
Describes a subscription.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
SubscriptionBase
Properties
| Property |
Type |
Description |
Rules |
Account |
string |
Gets or sets the account. |
Required. |
Alias |
string |
Gets or sets the alias. |
Required. |
Description |
string |
Gets or sets the description. |
Required. |
State |
Cegid.Lithium.Mobile.Client.Rest.Models.SubscritpionState |
Gets or sets the state. |
Required. |
Enterprises |
System.Collections.Generic.IList<Cegid.Lithium.Mobile.Client.Rest.Models.Enterprise>? |
Gets or sets the enterprises. |
|
^ Back to top
UserAuthorization
Describes an user authorization.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
- Inheritance:
UserAuthorizationBase
Properties
| Property |
Type |
Description |
Rules |
Subscription |
string? |
Gets or sets the subscription. |
|
UserId |
string |
Gets or sets the user identifier. |
Required. |
ModuleKey |
string |
Gets or sets the module key. |
Required. |
CompanyKey |
string |
Gets or sets the company key. |
Required. |
MappingInfo |
string? |
Gets or sets the mapping info. |
|
UserEmail |
string |
Gets or sets the user email. |
Required. |
Value |
string |
Gets or sets the value. |
Required. |
^ Back to top
Enumerations
LogLevel
Enumeration for log message severity.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
Members
| Member |
Value |
Description |
Information |
0 |
Information Log Level. |
Warning |
1 |
Warning Log Level. |
Error |
2 |
Error Log Level. |
^ Back to top
Modules
Available Mobile Modules.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
Members
| Member |
Value |
Description |
ErpUser |
0 |
An Erp User. |
HumanResources |
1 |
Human Resources Module. |
Sales |
2 |
Sales Module. |
Customers |
3 |
Customers Module. |
^ Back to top
SubscritpionState
Subscription States.
- Namespace:
Cegid.Lithium.Mobile.Client.Rest.Models
Members
| Member |
Value |
Description |
None |
0 |
No Subscription State. |
Active |
1 |
Active Subscription. |
Canceled |
4 |
Canceled Subscription. |
Idle |
3 |
Idle Subscription. |
Suspended |
2 |
Suspended Subscription. |
^ Back to top