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
import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class TestQvicklyApiSettingsQuery : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * The Qvickly Id
    */
    // @ApiMember(Description="The Qvickly Id")
    public var id:Int

    /**
    * The Qvickly secret
    */
    // @ApiMember(Description="The Qvickly secret")
    public var secret:String

    /**
    * The Qvickly receiver email
    */
    // @ApiMember(Description="The Qvickly receiver email")
    public var receiverEmail:String

    /**
    * The Qvickly receiver firstname
    */
    // @ApiMember(Description="The Qvickly receiver firstname")
    public var receiverFirstname:String

    /**
    * The Qvickly receiver lastname
    */
    // @ApiMember(Description="The Qvickly receiver lastname")
    public var receiverLastname:String

    required public init(){}
}

public class QvicklyApiSettingsTestResponse : Codable
{
    /**
    * If the settings works or not
    */
    // @ApiMember(Description="If the settings works or not")
    public var success:Bool

    required public init(){}
}


Swift 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}