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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type QvicklyApiSettingsTestResponse() = 
        ///<summary>
        ///If the settings works or not
        ///</summary>
        [<ApiMember(Description="If the settings works or not")>]
        member val Success:Boolean = new Boolean() with get,set

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type TestQvicklyApiSettingsQuery() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The Qvickly Id
        ///</summary>
        [<ApiMember(Description="The Qvickly Id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The Qvickly secret
        ///</summary>
        [<ApiMember(Description="The Qvickly secret")>]
        member val Secret:String = null with get,set

        ///<summary>
        ///The Qvickly receiver email
        ///</summary>
        [<ApiMember(Description="The Qvickly receiver email")>]
        member val ReceiverEmail:String = null with get,set

        ///<summary>
        ///The Qvickly receiver firstname
        ///</summary>
        [<ApiMember(Description="The Qvickly receiver firstname")>]
        member val ReceiverFirstname:String = null with get,set

        ///<summary>
        ///The Qvickly receiver lastname
        ///</summary>
        [<ApiMember(Description="The Qvickly receiver lastname")>]
        member val ReceiverLastname:String = null with get,set

F# TestQvicklyApiSettingsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length

{"Success":false}