BokaMera.API.Host

TestQvicklyApiSettingsQuery

The following routes are available for this service:
POST	/payment/billmate/apisettings/test	Test Qvickly api settings	Test Qvickly api settings for the logged in company

"use strict";
export class QvicklyApiSettingsTestResponse {
    /** @param {{Success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description If the settings works or not */
    Success;
}
export class TestQvicklyApiSettingsQuery {
    /** @param {{CompanyId?:string,Id?:number,Secret?:string,ReceiverEmail?:string,ReceiverFirstname?:string,ReceiverLastname?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description The Qvickly Id */
    Id;
    /**
     * @type {string}
     * @description The Qvickly secret */
    Secret;
    /**
     * @type {string}
     * @description The Qvickly receiver email */
    ReceiverEmail;
    /**
     * @type {string}
     * @description The Qvickly receiver firstname */
    ReceiverFirstname;
    /**
     * @type {string}
     * @description The Qvickly receiver lastname */
    ReceiverLastname;
}

JavaScript TestQvicklyApiSettingsQuery 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.

POST /payment/billmate/apisettings/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestQvicklyApiSettingsQuery 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>
</TestQvicklyApiSettingsQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QvicklyApiSettingsTestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Success>false</Success>
</QvicklyApiSettingsTestResponse>