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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QvicklyApiSettingsTestResponse:
    # @ApiMember(Description="If the settings works or not")
    success: bool = False
    """
    If the settings works or not
    """


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestQvicklyApiSettingsQuery(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The Qvickly Id")
    id: int = 0
    """
    The Qvickly Id
    """


    # @ApiMember(Description="The Qvickly secret")
    secret: Optional[str] = None
    """
    The Qvickly secret
    """


    # @ApiMember(Description="The Qvickly receiver email")
    receiver_email: Optional[str] = None
    """
    The Qvickly receiver email
    """


    # @ApiMember(Description="The Qvickly receiver firstname")
    receiver_firstname: Optional[str] = None
    """
    The Qvickly receiver firstname
    """


    # @ApiMember(Description="The Qvickly receiver lastname")
    receiver_lastname: Optional[str] = None
    """
    The Qvickly receiver lastname
    """

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