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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class QvicklyApiSettingsQuery
            Implements ICompany
            '''<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.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)
        End Class

        Public Partial Class QvicklyApiSettingsQueryResponse
            '''<Summary>
            '''The company id
            '''</Summary>
            <ApiMember(Description:="The company id")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''The Qvickly id
            '''</Summary>
            <ApiMember(Description:="The Qvickly id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The Qvickly secret
            '''</Summary>
            <ApiMember(Description:="The Qvickly secret")>
            Public Overridable Property Secret As String

            '''<Summary>
            '''The Qvickly receiver email
            '''</Summary>
            <ApiMember(Description:="The Qvickly receiver email")>
            Public Overridable Property ReceiverEmail As String

            '''<Summary>
            '''The Qvickly receiver firstname
            '''</Summary>
            <ApiMember(Description:="The Qvickly receiver firstname")>
            Public Overridable Property ReceiverFirstname As String

            '''<Summary>
            '''The Qvickly receiver lastname
            '''</Summary>
            <ApiMember(Description:="The Qvickly receiver lastname")>
            Public Overridable Property ReceiverLastname As String
        End Class
    End Namespace
End Namespace

VB.NET QvicklyApiSettingsQuery 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 /payment/billmate/apisettings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QvicklyApiSettingsQueryResponse 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>
  <Id>0</Id>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <Secret>String</Secret>
</QvicklyApiSettingsQueryResponse>