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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CodeLockRcoM5SettingResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        ///<summary>
        ///Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
        ///</summary>
        [<ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")>]
        member val ApiEndpoint:String = null with get,set

        ///<summary>
        ///Server id from rcoservers.config of the M5AdminAPI installation.
        ///</summary>
        [<ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")>]
        member val ServerId:Int32 = new Int32() with get,set

        ///<summary>
        ///System name exactly as in R-CARD M5 Arbetsstation.
        ///</summary>
        [<ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.")>]
        member val SystemName:String = null with get,set

        ///<summary>
        ///The API operator username to logon to the RCO M5 system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.")>]
        member val Username:String = null with get,set

        ///<summary>
        ///The API operator password to logon to the RCO M5 system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.")>]
        member val Password:String = null with get,set

        ///<summary>
        ///When settings were created
        ///</summary>
        [<ApiMember(DataType="datetime", Description="When settings were created")>]
        member val Created:DateTime = new DateTime() with get,set

        ///<summary>
        ///When settings were updated
        ///</summary>
        [<ApiMember(DataType="datetime", Description="When settings were updated")>]
        member val Updated:DateTime = new DateTime() with get,set

    [<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)>]
    [<AllowNullLiteral>]
    type UpdateRcoM5CodeLockSetting() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
        ///</summary>
        [<ApiMember(DataType="string", Description="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")>]
        member val ApiEndpoint:String = null with get,set

        ///<summary>
        ///Server id from rcoservers.config of the M5AdminAPI installation.
        ///</summary>
        [<ApiMember(DataType="int", Description="Server id from rcoservers.config of the M5AdminAPI installation.")>]
        member val ServerId:Int32 = new Int32() with get,set

        ///<summary>
        ///System name exactly as in R-CARD M5 Arbetsstation.
        ///</summary>
        [<ApiMember(DataType="string", Description="System name exactly as in R-CARD M5 Arbetsstation.")>]
        member val SystemName:String = null with get,set

        ///<summary>
        ///The API operator username to logon to the RCO M5 system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The API operator username to logon to the RCO M5 system.")>]
        member val Username:String = null with get,set

        ///<summary>
        ///The API operator password to logon to the RCO M5 system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The API operator password to logon to the RCO M5 system.")>]
        member val Password:String = null with get,set

F# UpdateRcoM5CodeLockSetting DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

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