BokaMera.API.Host

<back to all web services

QvicklyApiSettingsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/payment/billmate/apisettingsGet Qvickly api settingsGet Qvickly api settings for the logged in company
namespace BokaMera.API.ServiceModel.Dtos

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

    [<AllowNullLiteral>]
    type QvicklyApiSettingsQueryResponse() = 
        ///<summary>
        ///The company id
        ///</summary>
        [<ApiMember(Description="The company id")>]
        member val CompanyId:Guid = new Guid() with get,set

        ///<summary>
        ///The Qvickly id
        ///</summary>
        [<ApiMember(Description="The Qvickly id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The Qvickly secret
        ///</summary>
        [<ApiMember(Description="The Qvickly secret")>]
        member val Secret:String = null with get,set

        ///<summary>
        ///The Qvickly receiver email
        ///</summary>
        [<ApiMember(Description="The Qvickly receiver email")>]
        member val ReceiverEmail:String = null with get,set

        ///<summary>
        ///The Qvickly receiver firstname
        ///</summary>
        [<ApiMember(Description="The Qvickly receiver firstname")>]
        member val ReceiverFirstname:String = null with get,set

        ///<summary>
        ///The Qvickly receiver lastname
        ///</summary>
        [<ApiMember(Description="The Qvickly receiver lastname")>]
        member val ReceiverLastname:String = null with get,set

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type QvicklyApiSettingsQuery() = 
        ///<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

F# QvicklyApiSettingsQuery DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /payment/billmate/apisettings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Secret: String,
	ReceiverEmail: String,
	ReceiverFirstname: String,
	ReceiverLastname: String
}