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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class QvicklyApiSettingsQuery implements 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.")
        public UUID CompanyId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public QvicklyApiSettingsQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

    public static class QvicklyApiSettingsQueryResponse
    {
        /**
        * The company id
        */
        @ApiMember(Description="The company id")
        public UUID CompanyId = null;

        /**
        * The Qvickly id
        */
        @ApiMember(Description="The Qvickly id")
        public Integer Id = null;

        /**
        * The Qvickly secret
        */
        @ApiMember(Description="The Qvickly secret")
        public String Secret = null;

        /**
        * The Qvickly receiver email
        */
        @ApiMember(Description="The Qvickly receiver email")
        public String ReceiverEmail = null;

        /**
        * The Qvickly receiver firstname
        */
        @ApiMember(Description="The Qvickly receiver firstname")
        public String ReceiverFirstname = null;

        /**
        * The Qvickly receiver lastname
        */
        @ApiMember(Description="The Qvickly receiver lastname")
        public String ReceiverLastname = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public QvicklyApiSettingsQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public QvicklyApiSettingsQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getSecret() { return Secret; }
        public QvicklyApiSettingsQueryResponse setSecret(String value) { this.Secret = value; return this; }
        public String getReceiverEmail() { return ReceiverEmail; }
        public QvicklyApiSettingsQueryResponse setReceiverEmail(String value) { this.ReceiverEmail = value; return this; }
        public String getReceiverFirstname() { return ReceiverFirstname; }
        public QvicklyApiSettingsQueryResponse setReceiverFirstname(String value) { this.ReceiverFirstname = value; return this; }
        public String getReceiverLastname() { return ReceiverLastname; }
        public QvicklyApiSettingsQueryResponse setReceiverLastname(String value) { this.ReceiverLastname = value; return this; }
    }

}

Java 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>