BokaMera.API.Host

<back to all web services

CodeLockSiedleSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/siedle/settingsGet code lock api settings for the currently logged in userGet code lock api settings for 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 CodeLockSiedleSettingQuery 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;

    CodeLockSiedleSettingQuery({this.CompanyId});
    CodeLockSiedleSettingQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId
    };

    getTypeName() => "CodeLockSiedleSettingQuery";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'SiedleIntegrationType': TypeInfo(TypeOf.Enum, enumValues:SiedleIntegrationType.values),
    'CodeLockSiedleSettingResponse': TypeInfo(TypeOf.Class, create:() => CodeLockSiedleSettingResponse()),
    'CodeLockSiedleSettingQuery': TypeInfo(TypeOf.Class, create:() => CodeLockSiedleSettingQuery()),
});

Dart CodeLockSiedleSettingQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /codelock/siedle/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ApiEndpoint":"String","ApiPort":0,"DeviceId":"String","Username":"String","Password":"String","IntegrationType":"LocalApi"}