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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PaysonApiSettingsTestResponse() = 
        ///<summary>
        ///If the settings works or not
        ///</summary>
        [<ApiMember(Description="If the settings works or not")>]
        member val Success:Boolean = new Boolean() with get,set

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type TestPaysonApiSettings() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The payson security user id
        ///</summary>
        [<ApiMember(Description="The payson security user id")>]
        member val SecurityUserId:String = null with get,set

        ///<summary>
        ///The payson security user password
        ///</summary>
        [<ApiMember(Description="The payson security user password")>]
        member val SecurityPassword:String = null with get,set

        ///<summary>
        ///The payson receiver email
        ///</summary>
        [<ApiMember(Description="The payson receiver email")>]
        member val ReceiverEmail:String = null with get,set

        ///<summary>
        ///The payson receiver firstname
        ///</summary>
        [<ApiMember(Description="The payson receiver firstname")>]
        member val ReceiverFirstname:String = null with get,set

        ///<summary>
        ///The payson receiver lastname
        ///</summary>
        [<ApiMember(Description="The payson receiver lastname")>]
        member val ReceiverLastname:String = null with get,set

F# 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>