BokaMera.API.Host

<back to all web services

UpdateRcoM5CodeLockSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/codelock/rcom5/settingsUpdate settings for the RCO M5 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 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 UpdateRcoM5CodeLockSetting : 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?

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

    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 UpdateRcoM5CodeLockSetting 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.

PUT /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"ApiEndpoint":"String","ServerId":0,"SystemName":"String","Username":"String","Password":"String"}