BokaMera.API.Host

<back to all web services

AddQvicklyApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/billmate/apisettingsAdd Qvickly api settingsAdd Qvickly 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
{
    [ValidateRequest("IsAuthenticated")]
    public partial class AddQvicklyApiSettings
        : 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", IsRequired=true)]
        public virtual int Id { get; set; }

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

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

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

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

    public partial class QvicklyApiSettingsQueryResponse
    {
        ///<summary>
        ///The company id
        ///</summary>
        [ApiMember(Description="The company id")]
        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# AddQvicklyApiSettings DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/billmate/apisettings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Id":0,"Secret":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}