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

export class QvicklyApiSettingsQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The Qvickly id */
    // @ApiMember(Description="The Qvickly id")
    public Id: number;

    /** @description The Qvickly secret */
    // @ApiMember(Description="The Qvickly secret")
    public Secret: string;

    /** @description The Qvickly receiver email */
    // @ApiMember(Description="The Qvickly receiver email")
    public ReceiverEmail: string;

    /** @description The Qvickly receiver firstname */
    // @ApiMember(Description="The Qvickly receiver firstname")
    public ReceiverFirstname: string;

    /** @description The Qvickly receiver lastname */
    // @ApiMember(Description="The Qvickly receiver lastname")
    public ReceiverLastname: string;

    public constructor(init?: Partial<QvicklyApiSettingsQueryResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class QvicklyApiSettingsQuery implements ICompany
{
    /** @description 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 CompanyId?: string;

    public constructor(init?: Partial<QvicklyApiSettingsQuery>) { (Object as any).assign(this, init); }
}

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