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

using System;
using System.IO;
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 QvicklyApiSettingsTestResponse
    {
        ///<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 TestQvicklyApiSettingsQuery
        : 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 Qvickly Id
        ///</summary>
        [ApiMember(Description="The Qvickly Id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The Qvickly secret
        ///</summary>
        [ApiMember(Description="The Qvickly secret")]
        public virtual string Secret { get; set; }

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

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

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

}

C# TestQvicklyApiSettingsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: 0,
	Secret: String,
	ReceiverEmail: String,
	ReceiverFirstname: String,
	ReceiverLastname: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False
}