BokaMera.API.Host

<back to all web services

AddAxemaCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/axema/settingsAdd settings for the 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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @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)
    public static class AddAxemaCodeLockSetting implements ICompany
    {
        /**
        * 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.")
        public UUID CompanyId = null;

        /**
        * The api endpoint of the code lock
        */
        @ApiMember(DataType="string", Description="The api endpoint of the code lock", IsRequired=true)
        public String ApiEndpoint = null;

        /**
        * The api port for the code lock.
        */
        @ApiMember(DataType="string", Description="The api port for the code lock.", IsRequired=true)
        public String ApiPort = null;

        /**
        * The username to logon to the code lock.
        */
        @ApiMember(DataType="string", Description="The username to logon to the code lock.", IsRequired=true)
        public String Username = null;

        /**
        * The password to logon to the code lock.
        */
        @ApiMember(DataType="string", Description="The password to logon to the code lock.", IsRequired=true)
        public String Password = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public AddAxemaCodeLockSetting setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public AddAxemaCodeLockSetting setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public String getApiPort() { return ApiPort; }
        public AddAxemaCodeLockSetting setApiPort(String value) { this.ApiPort = value; return this; }
        public String getUsername() { return Username; }
        public AddAxemaCodeLockSetting setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public AddAxemaCodeLockSetting setPassword(String value) { this.Password = value; return this; }
    }

    public static class CodeLockAxemaSettingResponse
    {
        public UUID CompanyId = null;
        /**
        * The api endpoint of the code lock
        */
        @ApiMember(DataType="string", Description="The api endpoint of the code lock")
        public String ApiEndpoint = null;

        /**
        * The api port for the code lock.
        */
        @ApiMember(DataType="string", Description="The api port for the code lock.")
        public Integer ApiPort = null;

        /**
        * The username to logon to the code lock.
        */
        @ApiMember(DataType="string", Description="The username to logon to the code lock.")
        public String Username = null;

        /**
        * The password to logon to the code lock.
        */
        @ApiMember(DataType="string", Description="The password to logon to the code lock.")
        public String Password = null;

        /**
        * When settings was created
        */
        @ApiMember(DataType="datetime", Description="When settings was created")
        public Date Created = null;

        /**
        * When settings was updated
        */
        @ApiMember(DataType="datetime", Description="When settings was updated")
        public Date Updated = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CodeLockAxemaSettingResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public CodeLockAxemaSettingResponse setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public Integer getApiPort() { return ApiPort; }
        public CodeLockAxemaSettingResponse setApiPort(Integer value) { this.ApiPort = value; return this; }
        public String getUsername() { return Username; }
        public CodeLockAxemaSettingResponse setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public CodeLockAxemaSettingResponse setPassword(String value) { this.Password = value; return this; }
        public Date getCreated() { return Created; }
        public CodeLockAxemaSettingResponse setCreated(Date value) { this.Created = value; return this; }
        public Date getUpdated() { return Updated; }
        public CodeLockAxemaSettingResponse setUpdated(Date value) { this.Updated = value; return this; }
    }

}

Java AddAxemaCodeLockSetting DTOs

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

HTTP + CSV

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

POST /codelock/axema/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"ApiEndpoint":"String","ApiPort":0,"Username":"String","Password":"String"}