BokaMera.API.Host

<back to all web services

UpdateQvicklyApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/payment/billmate/apisettings/Update Qvickly api settingsUpdate 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 QvicklyApiSettingsQueryResponse:
    # @ApiMember(Description="The company id")
    company_id: Optional[str] = None
    """
    The company id
    """


    # @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
    """


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateQvicklyApiSettings(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: Optional[int] = None
    """
    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 UpdateQvicklyApiSettings DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /payment/billmate/apisettings/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateQvicklyApiSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>0</Id>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <Secret>String</Secret>
</UpdateQvicklyApiSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QvicklyApiSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>0</Id>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <Secret>String</Secret>
</QvicklyApiSettingsQueryResponse>