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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class PaysonApiSettingsTestResponse
    {
        ///<summary>
        ///If the settings works or not
        ///</summary>
        [ApiMember(Description="If the settings works or not")]
        public virtual bool Success { get; set; }
    }

    [ValidateRequest("IsAuthenticated")]
    public partial class TestPaysonApiSettings
        : 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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The payson security user id
        ///</summary>
        [ApiMember(Description="The payson security user id")]
        public virtual string SecurityUserId { get; set; }

        ///<summary>
        ///The payson security user password
        ///</summary>
        [ApiMember(Description="The payson security user password")]
        public virtual string SecurityPassword { get; set; }

        ///<summary>
        ///The payson receiver email
        ///</summary>
        [ApiMember(Description="The payson receiver email")]
        public virtual string ReceiverEmail { get; set; }

        ///<summary>
        ///The payson receiver firstname
        ///</summary>
        [ApiMember(Description="The payson receiver firstname")]
        public virtual string ReceiverFirstname { get; set; }

        ///<summary>
        ///The payson receiver lastname
        ///</summary>
        [ApiMember(Description="The payson receiver lastname")]
        public virtual string ReceiverLastname { get; set; }
    }

}

C# 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: api.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>