BokaMera.API.Host

<back to all web services

CodeLockIloqSettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/codelock/iloq/settingsGet code lock api settings for the currently logged in userGet 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 CodeLockIloqSettingQuery : 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 CodeLockIloqSettingResponse : Codable
{
    public var companyId:String
    /**
    * The iLOQ system identifier (e.g. ILOQ_21140)
    */
    // @ApiMember(DataType="string", Description="The iLOQ system identifier (e.g. ILOQ_21140)")
    public var customerCode:String

    /**
    * The username to logon to the iLOQ system.
    */
    // @ApiMember(DataType="string", Description="The username to logon to the iLOQ system.")
    public var username:String

    /**
    * The password to logon to the iLOQ system.
    */
    // @ApiMember(DataType="string", Description="The password to logon to the iLOQ system.")
    public var password:String

    /**
    * The default Security Access name to use when no resource access group is specified.
    */
    // @ApiMember(DataType="string", Description="The default Security Access name to use when no resource access group is specified.")
    public var defaultSecurityAccessName: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 CodeLockIloqSettingQuery 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/iloq/settings HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockIloqSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CustomerCode>String</CustomerCode>
  <DefaultSecurityAccessName>String</DefaultSecurityAccessName>
  <Password>String</Password>
  <Updated>0001-01-01T00:00:00</Updated>
  <Username>String</Username>
</CodeLockIloqSettingResponse>