| POST | /payment/billmate/apisettings/test | Test Qvickly api settings | Test Qvickly 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 QvicklyApiSettingsTestResponse() =
///<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 TestQvicklyApiSettingsQuery() =
///<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 Qvickly Id
///</summary>
[<ApiMember(Description="The Qvickly Id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The Qvickly secret
///</summary>
[<ApiMember(Description="The Qvickly secret")>]
member val Secret:String = null with get,set
///<summary>
///The Qvickly receiver email
///</summary>
[<ApiMember(Description="The Qvickly receiver email")>]
member val ReceiverEmail:String = null with get,set
///<summary>
///The Qvickly receiver firstname
///</summary>
[<ApiMember(Description="The Qvickly receiver firstname")>]
member val ReceiverFirstname:String = null with get,set
///<summary>
///The Qvickly receiver lastname
///</summary>
[<ApiMember(Description="The Qvickly receiver lastname")>]
member val ReceiverLastname:String = null with get,set
F# TestQvicklyApiSettingsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: testapi.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>