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

import 'package:servicestack/servicestack.dart';

class QvicklyApiSettingsTestResponse implements IConvertible
{
    /**
    * If the settings works or not
    */
    // @ApiMember(Description="If the settings works or not")
    bool? Success;

    QvicklyApiSettingsTestResponse({this.Success});
    QvicklyApiSettingsTestResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success
    };

    getTypeName() => "QvicklyApiSettingsTestResponse";
    TypeContext? context = _ctx;
}

// @ValidateRequest(Validator="IsAuthenticated")
class TestQvicklyApiSettingsQuery implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * The Qvickly Id
    */
    // @ApiMember(Description="The Qvickly Id")
    int? Id;

    /**
    * The Qvickly secret
    */
    // @ApiMember(Description="The Qvickly secret")
    String? Secret;

    /**
    * The Qvickly receiver email
    */
    // @ApiMember(Description="The Qvickly receiver email")
    String? ReceiverEmail;

    /**
    * The Qvickly receiver firstname
    */
    // @ApiMember(Description="The Qvickly receiver firstname")
    String? ReceiverFirstname;

    /**
    * The Qvickly receiver lastname
    */
    // @ApiMember(Description="The Qvickly receiver lastname")
    String? ReceiverLastname;

    TestQvicklyApiSettingsQuery({this.CompanyId,this.Id,this.Secret,this.ReceiverEmail,this.ReceiverFirstname,this.ReceiverLastname});
    TestQvicklyApiSettingsQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        Secret = json['Secret'];
        ReceiverEmail = json['ReceiverEmail'];
        ReceiverFirstname = json['ReceiverFirstname'];
        ReceiverLastname = json['ReceiverLastname'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'Secret': Secret,
        'ReceiverEmail': ReceiverEmail,
        'ReceiverFirstname': ReceiverFirstname,
        'ReceiverLastname': ReceiverLastname
    };

    getTypeName() => "TestQvicklyApiSettingsQuery";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'QvicklyApiSettingsTestResponse': TypeInfo(TypeOf.Class, create:() => QvicklyApiSettingsTestResponse()),
    'TestQvicklyApiSettingsQuery': TypeInfo(TypeOf.Class, create:() => TestQvicklyApiSettingsQuery()),
});

Dart TestQvicklyApiSettingsQuery 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.

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

<TestQvicklyApiSettingsQuery 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>
</TestQvicklyApiSettingsQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QvicklyApiSettingsTestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Success>false</Success>
</QvicklyApiSettingsTestResponse>