BokaMera.API.Host

<back to all web services

AddQvicklyApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/billmate/apisettingsAdd Qvickly api settingsAdd Qvickly api settings for the logged in company
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class AddQvicklyApiSettings : ICompany
{
    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * The Qvickly id
    */
    @ApiMember(Description="The Qvickly id", IsRequired=true)
    var Id:Int? = null

    /**
    * The Qvickly secret
    */
    @ApiMember(Description="The Qvickly secret", IsRequired=true)
    var Secret:String? = null

    /**
    * The Qvickly receiver email
    */
    @ApiMember(Description="The Qvickly receiver email", IsRequired=true)
    var ReceiverEmail:String? = null

    /**
    * The Qvickly receiver firstname
    */
    @ApiMember(Description="The Qvickly receiver firstname", IsRequired=true)
    var ReceiverFirstname:String? = null

    /**
    * The Qvickly receiver lastname
    */
    @ApiMember(Description="The Qvickly receiver lastname", IsRequired=true)
    var ReceiverLastname:String? = null
}

open class QvicklyApiSettingsQueryResponse
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id")
    var CompanyId:UUID? = null

    /**
    * The Qvickly id
    */
    @ApiMember(Description="The Qvickly id")
    var Id:Int? = null

    /**
    * The Qvickly secret
    */
    @ApiMember(Description="The Qvickly secret")
    var Secret:String? = null

    /**
    * The Qvickly receiver email
    */
    @ApiMember(Description="The Qvickly receiver email")
    var ReceiverEmail:String? = null

    /**
    * The Qvickly receiver firstname
    */
    @ApiMember(Description="The Qvickly receiver firstname")
    var ReceiverFirstname:String? = null

    /**
    * The Qvickly receiver lastname
    */
    @ApiMember(Description="The Qvickly receiver lastname")
    var ReceiverLastname:String? = null
}

Kotlin AddQvicklyApiSettings 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.

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: 0,
	Secret: String,
	ReceiverEmail: String,
	ReceiverFirstname: String,
	ReceiverLastname: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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