BokaMera.API.Host

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/settings	Get code lock api settings for the currently logged in user	Get code lock api settings for the currently logged in user.

import Foundation
import ServiceStack

// @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 class CodeLockRcoM5SettingQuery : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    required public init(){}
}

public class CodeLockRcoM5SettingResponse : Codable
{
    public var companyId:String
    /**
    * 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 var apiEndpoint:String

    /**
    * Server id from rcoservers.config of the M5AdminAPI installation.
    */
    // @ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")
    public var serverId:Int

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

    /**
    * 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 var username:String

    /**
    * 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 var password:String

    /**
    * When settings were created
    */
    // @ApiMember(DataType="datetime", Description="When settings were created")
    public var created:Date

    /**
    * When settings were updated
    */
    // @ApiMember(DataType="datetime", Description="When settings were updated")
    public var updated:Date

    required public init(){}
}

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