BokaMera.API.Host

<back to all web services

UpdateAxemaCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/axema/settingsUpdate settings for the code lock of the company of the currently logged in userUpdate settings for code lock of the company of the currently logged in user.
import 'package:servicestack/servicestack.dart';

class CodeLockAxemaSettingResponse 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 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;

    /**
    * 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;

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

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        ApiEndpoint = json['ApiEndpoint'];
        ApiPort = json['ApiPort'];
        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,
        'ApiPort': ApiPort,
        'Username': Username,
        'Password': Password,
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'Updated': JsonConverters.toJson(Updated,'DateTime',context!)
    };

    getTypeName() => "CodeLockAxemaSettingResponse";
    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 UpdateAxemaCodeLockSetting 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 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;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'CodeLockAxemaSettingResponse': TypeInfo(TypeOf.Class, create:() => CodeLockAxemaSettingResponse()),
    'UpdateAxemaCodeLockSetting': TypeInfo(TypeOf.Class, create:() => UpdateAxemaCodeLockSetting()),
});

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

PUT /codelock/axema/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAxemaCodeLockSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ApiEndpoint>String</ApiEndpoint>
  <ApiPort>String</ApiPort>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Password>String</Password>
  <Username>String</Username>
</UpdateAxemaCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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