BokaMera.API.Host

<back to all web services

AddSiedleCodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/siedle/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 AddSiedleCodeLockSetting 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 device id to the code lock.
        */
        @ApiMember(DataType="string", Description="The device id to the code lock.")
        public String DeviceId = null;

        /**
        * 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")
        public SiedleIntegrationType IntegrationType = 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 AddSiedleCodeLockSetting setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public AddSiedleCodeLockSetting setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public String getApiPort() { return ApiPort; }
        public AddSiedleCodeLockSetting setApiPort(String value) { this.ApiPort = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public AddSiedleCodeLockSetting setDeviceId(String value) { this.DeviceId = value; return this; }
        public SiedleIntegrationType getIntegrationType() { return IntegrationType; }
        public AddSiedleCodeLockSetting setIntegrationType(SiedleIntegrationType value) { this.IntegrationType = value; return this; }
        public String getUsername() { return Username; }
        public AddSiedleCodeLockSetting setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public AddSiedleCodeLockSetting setPassword(String value) { this.Password = value; return this; }
    }

    public static enum SiedleIntegrationType
    {
        LocalApi(1),
        CloudBasedApi(2);

        private final int value;
        SiedleIntegrationType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class CodeLockSiedleSettingResponse
    {
        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 device id to the code lock.
        */
        @ApiMember(DataType="string", Description="The device id to the code lock.")
        public String DeviceId = 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;

        /**
        * 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")
        public SiedleIntegrationType IntegrationType = 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 CodeLockSiedleSettingResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public CodeLockSiedleSettingResponse setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public Integer getApiPort() { return ApiPort; }
        public CodeLockSiedleSettingResponse setApiPort(Integer value) { this.ApiPort = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public CodeLockSiedleSettingResponse setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getUsername() { return Username; }
        public CodeLockSiedleSettingResponse setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public CodeLockSiedleSettingResponse setPassword(String value) { this.Password = value; return this; }
        public SiedleIntegrationType getIntegrationType() { return IntegrationType; }
        public CodeLockSiedleSettingResponse setIntegrationType(SiedleIntegrationType value) { this.IntegrationType = value; return this; }
        public Date getCreated() { return Created; }
        public CodeLockSiedleSettingResponse setCreated(Date value) { this.Created = value; return this; }
        public Date getUpdated() { return Updated; }
        public CodeLockSiedleSettingResponse setUpdated(Date value) { this.Updated = value; return this; }
    }

}

Java AddSiedleCodeLockSetting 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.

POST /codelock/siedle/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddSiedleCodeLockSetting 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>
  <DeviceId>String</DeviceId>
  <IntegrationType>LocalApi</IntegrationType>
  <Password>String</Password>
  <Username>String</Username>
</AddSiedleCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockSiedleSettingResponse 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>
  <DeviceId>String</DeviceId>
  <IntegrationType>LocalApi</IntegrationType>
  <Password>String</Password>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockSiedleSettingResponse>