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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class QvicklyApiSettingsTestResponse
            '''<Summary>
            '''If the settings works or not
            '''</Summary>
            <ApiMember(Description:="If the settings works or not")>
            Public Overridable Property Success As Boolean
        End Class

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class TestQvicklyApiSettingsQuery
            Implements ICompany
            '''<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.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''The Qvickly Id
            '''</Summary>
            <ApiMember(Description:="The Qvickly Id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The Qvickly secret
            '''</Summary>
            <ApiMember(Description:="The Qvickly secret")>
            Public Overridable Property Secret As String

            '''<Summary>
            '''The Qvickly receiver email
            '''</Summary>
            <ApiMember(Description:="The Qvickly receiver email")>
            Public Overridable Property ReceiverEmail As String

            '''<Summary>
            '''The Qvickly receiver firstname
            '''</Summary>
            <ApiMember(Description:="The Qvickly receiver firstname")>
            Public Overridable Property ReceiverFirstname As String

            '''<Summary>
            '''The Qvickly receiver lastname
            '''</Summary>
            <ApiMember(Description:="The Qvickly receiver lastname")>
            Public Overridable Property ReceiverLastname As String
        End Class
    End Namespace
End Namespace

VB.NET 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}