BokaMera.API.Host

<back to all web services

TestPaysonApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/payson/apisettings/testTest payson api settingsTest payson api settings for the logged in company
import 'package:servicestack/servicestack.dart';

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

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

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

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

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

// @ValidateRequest(Validator="IsAuthenticated")
class TestPaysonApiSettings 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 payson security user id
    */
    // @ApiMember(Description="The payson security user id")
    String? SecurityUserId;

    /**
    * The payson security user password
    */
    // @ApiMember(Description="The payson security user password")
    String? SecurityPassword;

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

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

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

    TestPaysonApiSettings({this.CompanyId,this.SecurityUserId,this.SecurityPassword,this.ReceiverEmail,this.ReceiverFirstname,this.ReceiverLastname});
    TestPaysonApiSettings.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'PaysonApiSettingsTestResponse': TypeInfo(TypeOf.Class, create:() => PaysonApiSettingsTestResponse()),
    'TestPaysonApiSettings': TypeInfo(TypeOf.Class, create:() => TestPaysonApiSettings()),
});

Dart TestPaysonApiSettings 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/payson/apisettings/test HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestPaysonApiSettings 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>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <SecurityPassword>String</SecurityPassword>
  <SecurityUserId>String</SecurityUserId>
</TestPaysonApiSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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