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 java.math.*;
import java.util.*;
import java.io.InputStream;
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 CodeLockRcoM5SettingQuery 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;
        
        public UUID getCompanyId() { return CompanyId; }
        public CodeLockRcoM5SettingQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

    public static class CodeLockRcoM5SettingResponse
    {
        public UUID CompanyId = null;
        /**
        * 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/).")
        public String ApiEndpoint = null;

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

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

        /**
        * 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.")
        public String Username = null;

        /**
        * 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.")
        public String Password = null;

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

        /**
        * When settings were updated
        */
        @ApiMember(DataType="datetime", Description="When settings were updated")
        public Date Updated = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CodeLockRcoM5SettingResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getApiEndpoint() { return ApiEndpoint; }
        public CodeLockRcoM5SettingResponse setApiEndpoint(String value) { this.ApiEndpoint = value; return this; }
        public Integer getServerId() { return ServerId; }
        public CodeLockRcoM5SettingResponse setServerId(Integer value) { this.ServerId = value; return this; }
        public String getSystemName() { return SystemName; }
        public CodeLockRcoM5SettingResponse setSystemName(String value) { this.SystemName = value; return this; }
        public String getUsername() { return Username; }
        public CodeLockRcoM5SettingResponse setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public CodeLockRcoM5SettingResponse setPassword(String value) { this.Password = value; return this; }
        public Date getCreated() { return Created; }
        public CodeLockRcoM5SettingResponse setCreated(Date value) { this.Created = value; return this; }
        public Date getUpdated() { return Updated; }
        public CodeLockRcoM5SettingResponse setUpdated(Date value) { this.Updated = value; return this; }
    }

}

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