Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /codelock/siedle/settings | Update settings for the code lock of the company of the currently logged in user | Update settings for code lock of the company of the currently logged in user. |
---|
import 'package:servicestack/servicestack.dart';
enum SiedleIntegrationType
{
LocalApi,
CloudBasedApi,
}
class CodeLockSiedleSettingResponse implements IConvertible
{
String? CompanyId;
/**
* The api endpoint of the code lock
*/
// @ApiMember(DataType="string", Description="The api endpoint of the code lock")
String? ApiEndpoint;
/**
* The api port for the code lock.
*/
// @ApiMember(DataType="string", Description="The api port for the code lock.")
int? ApiPort;
/**
* The device id to the code lock.
*/
// @ApiMember(DataType="string", Description="The device id to the code lock.")
String? DeviceId;
/**
* The username to logon to the code lock.
*/
// @ApiMember(DataType="string", Description="The username to logon to the code lock.")
String? Username;
/**
* The password to logon to the code lock.
*/
// @ApiMember(DataType="string", Description="The password to logon to the code lock.")
String? Password;
/**
* The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
*/
// @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")
SiedleIntegrationType? IntegrationType;
/**
* When settings was created
*/
// @ApiMember(DataType="datetime", Description="When settings was created")
DateTime? Created;
/**
* When settings was updated
*/
// @ApiMember(DataType="datetime", Description="When settings was updated")
DateTime? Updated;
CodeLockSiedleSettingResponse({this.CompanyId,this.ApiEndpoint,this.ApiPort,this.DeviceId,this.Username,this.Password,this.IntegrationType,this.Created,this.Updated});
CodeLockSiedleSettingResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
ApiEndpoint = json['ApiEndpoint'];
ApiPort = json['ApiPort'];
DeviceId = json['DeviceId'];
Username = json['Username'];
Password = json['Password'];
IntegrationType = JsonConverters.fromJson(json['IntegrationType'],'SiedleIntegrationType',context!);
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'ApiEndpoint': ApiEndpoint,
'ApiPort': ApiPort,
'DeviceId': DeviceId,
'Username': Username,
'Password': Password,
'IntegrationType': JsonConverters.toJson(IntegrationType,'SiedleIntegrationType',context!),
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'Updated': JsonConverters.toJson(Updated,'DateTime',context!)
};
getTypeName() => "CodeLockSiedleSettingResponse";
TypeContext? context = _ctx;
}
// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
class UpdateSiedleCodeLockSetting implements ICompany, IConvertible
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
String? CompanyId;
/**
* The api endpoint of the code lock
*/
// @ApiMember(DataType="string", Description="The api endpoint of the code lock")
String? ApiEndpoint;
/**
* The api port for the code lock.
*/
// @ApiMember(DataType="string", Description="The api port for the code lock.")
String? ApiPort;
/**
* The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api
*/
// @ApiMember(DataType="string", Description="The integration type to the code lock. 1 = Local Api, 2 = Cloud Based Api")
SiedleIntegrationType? IntegrationType;
/**
* The device id to the code lock.
*/
// @ApiMember(DataType="string", Description="The device id to the code lock.")
String? DeviceId;
/**
* The username to logon to the code lock.
*/
// @ApiMember(DataType="string", Description="The username to logon to the code lock.")
String? Username;
/**
* The password to logon to the code lock.
*/
// @ApiMember(DataType="string", Description="The password to logon to the code lock.")
String? Password;
UpdateSiedleCodeLockSetting({this.CompanyId,this.ApiEndpoint,this.ApiPort,this.IntegrationType,this.DeviceId,this.Username,this.Password});
UpdateSiedleCodeLockSetting.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
ApiEndpoint = json['ApiEndpoint'];
ApiPort = json['ApiPort'];
IntegrationType = JsonConverters.fromJson(json['IntegrationType'],'SiedleIntegrationType',context!);
DeviceId = json['DeviceId'];
Username = json['Username'];
Password = json['Password'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'ApiEndpoint': ApiEndpoint,
'ApiPort': ApiPort,
'IntegrationType': JsonConverters.toJson(IntegrationType,'SiedleIntegrationType',context!),
'DeviceId': DeviceId,
'Username': Username,
'Password': Password
};
getTypeName() => "UpdateSiedleCodeLockSetting";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'SiedleIntegrationType': TypeInfo(TypeOf.Enum, enumValues:SiedleIntegrationType.values),
'CodeLockSiedleSettingResponse': TypeInfo(TypeOf.Class, create:() => CodeLockSiedleSettingResponse()),
'UpdateSiedleCodeLockSetting': TypeInfo(TypeOf.Class, create:() => UpdateSiedleCodeLockSetting()),
});
Dart UpdateSiedleCodeLockSetting DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /codelock/siedle/settings HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
ApiEndpoint: String,
ApiPort: String,
IntegrationType: LocalApi,
DeviceId: String,
Username: String,
Password: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { ApiEndpoint: String, ApiPort: 0, DeviceId: String, Username: String, Password: String, IntegrationType: LocalApi }