BokaMera.API.Host

<back to all web services

CodeLockRcoM5SettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/rcom5/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';

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 CodeLockRcoM5SettingQuery 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;

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

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

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

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

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

Dart CodeLockRcoM5SettingQuery DTOs

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

HTTP + XML

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

GET /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockRcoM5SettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <Password>String</Password>
  <ServerId>0</ServerId>
  <SystemName>String</SystemName>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockRcoM5SettingResponse>