BokaMera.API.Host

<back to all web services

TestQvicklyApiSettingsQuery

Requires Authentication
The following routes are available for this service:
POST/payment/billmate/apisettings/testTest Qvickly api settingsTest 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

{"Success":false}