BokaMera.API.Host

<back to all web services

AddRcoM5CodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/rcom5/settingsAdd settings for the RCO M5 code lock of the company of the currently logged in userAdd settings for code lock of the company of the currently logged in user.
import 'package:servicestack/servicestack.dart';

class CodeLockRcoM5SettingResponse implements IConvertible
{
    String CompanyId = "";
    /**
    * Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
    */
    // @ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")
    String ApiEndpoint = "";

    /**
    * Server id from rcoservers.config of the M5AdminAPI installation.
    */
    // @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")
    int ServerId = 0;

    /**
    * System name exactly as in R-CARD M5 Arbetsstation.
    */
    // @ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.")
    String SystemName = "";

    /**
    * The API operator username to logon to the RCO M5 system.
    */
    // @ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.")
    String Username = "";

    /**
    * The API operator password to logon to the RCO M5 system.
    */
    // @ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.")
    String Password = "";

    /**
    * When settings were created
    */
    // @ApiMember(DataType="datetime", Description="When settings were created")
    DateTime Created = DateTime(0);

    /**
    * When settings were updated
    */
    // @ApiMember(DataType="datetime", Description="When settings were updated")
    DateTime Updated = DateTime(0);

    CodeLockRcoM5SettingResponse({this.CompanyId,this.ApiEndpoint,this.ServerId,this.SystemName,this.Username,this.Password,this.Created,this.Updated});
    CodeLockRcoM5SettingResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        ApiEndpoint = json['ApiEndpoint'];
        ServerId = json['ServerId'];
        SystemName = json['SystemName'];
        Username = json['Username'];
        Password = json['Password'];
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'ApiEndpoint': ApiEndpoint,
        'ServerId': ServerId,
        'SystemName': SystemName,
        'Username': Username,
        'Password': Password,
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'Updated': JsonConverters.toJson(Updated,'DateTime',context!)
    };

    getTypeName() => "CodeLockRcoM5SettingResponse";
    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 AddRcoM5CodeLockSetting 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;

    /**
    * Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
    */
    // @ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")
    String ApiEndpoint = "";

    /**
    * Server id from rcoservers.config of the M5AdminAPI installation.
    */
    // @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.", IsRequired=true)
    int ServerId = 0;

    /**
    * System name exactly as in R-CARD M5 Arbetsstation.
    */
    // @ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.", IsRequired=true)
    String SystemName = "";

    /**
    * The API operator username to logon to the RCO M5 system.
    */
    // @ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.", IsRequired=true)
    String Username = "";

    /**
    * The API operator password to logon to the RCO M5 system.
    */
    // @ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.", IsRequired=true)
    String Password = "";

    AddRcoM5CodeLockSetting({this.CompanyId,this.ApiEndpoint,this.ServerId,this.SystemName,this.Username,this.Password});
    AddRcoM5CodeLockSetting.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'ApiEndpoint': ApiEndpoint,
        'ServerId': ServerId,
        'SystemName': SystemName,
        'Username': Username,
        'Password': Password
    };

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

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'CodeLockRcoM5SettingResponse': TypeInfo(TypeOf.Class, create:() => CodeLockRcoM5SettingResponse()),
    'AddRcoM5CodeLockSetting': TypeInfo(TypeOf.Class, create:() => AddRcoM5CodeLockSetting()),
});

Dart AddRcoM5CodeLockSetting 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.

POST /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}