BokaMera.API.Host

<back to all web services

UpdateVanderbiltCodeLockSetting

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

    /**
    * The api endpoint of the code lock
    */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    public var apiEndpoint:String

    /**
    * The api port for the code lock.
    */
    // @ApiMember(DataType="string", Description="The api port for the code lock.")
    public var apiPort:String

    /**
    * The default identifier for the code lock.
    */
    // @ApiMember(DataType="string", Description="The default identifier for the code lock.")
    public var identifier:String

    /**
    * The default facility id to be used when no set on the resource.
    */
    // @ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")
    public var defaultFacilityId:String

    required public init(){}
}

public class CodeLockVanderbiltSettingResponse : Codable
{
    public var companyId:String
    /**
    * The api endpoint of the code lock
    */
    // @ApiMember(DataType="string", Description="The api endpoint of the code lock")
    public var apiEndpoint:String

    /**
    * The api port for the code lock.
    */
    // @ApiMember(DataType="string", Description="The api port for the code lock.")
    public var apiPort:Int

    /**
    * The default identifier for the code lock.
    */
    // @ApiMember(DataType="string", Description="The default identifier for the code lock.")
    public var identifier:String

    /**
    * The default facility id to be used when no set on the resource.
    */
    // @ApiMember(DataType="string", Description="The default facility id to be used when no set on the resource.")
    public var defaultFacilityId:Int?

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

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

    required public init(){}
}


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

PUT /codelock/vanderbilt/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateVanderbiltCodeLockSetting 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>
  <DefaultFacilityId>String</DefaultFacilityId>
  <Identifier>String</Identifier>
</UpdateVanderbiltCodeLockSetting>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CodeLockVanderbiltSettingResponse 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>
  <DefaultFacilityId>0</DefaultFacilityId>
  <Identifier>String</Identifier>
  <Updated>0001-01-01T00:00:00</Updated>
</CodeLockVanderbiltSettingResponse>