QuickBookSoap2Rest 1.0.0

QuickBookSoap2Rest

A simple library was written by C# ASP.Net Core web API application supported communicates with QBWebConnector (of QuickBooks)

Installation

Use Package Manager to install it.

Install-Package RXN.AspNetCore.QuickBookSoap2Rest -Version 2.0.0

Or .NET cli

dotnet add package RXN.AspNetCore.QuickBookSoap2Rest --version 2.0.0

Or PackageReference

<PackageReference Include="RXN.AspNetCore.QuickBookSoap2Rest" Version="2.0.0" />

Or Paket CLI

paket add RXN.AspNetCore.QuickBookSoap2Rest --version 2.0.0

Usage

There are two interfaces for handling Request of .Net core API

IWCWebMethod and IWCWebMethodAsync

Implement from IWCWebMethod if you just want to a synchronous function Implement from IWCWebMethodAsyncif you just want to an asynchronous function

Example

• Implement IWCWebMethod

using RXN.AspNetCore.QuickBookSoap2Rest.Interfaces;

// ...

// The handle class take care all business when QBWC requested to server
public class WCRequestHandler : IWCWebMethod
{
    // must implement all methods supporting WC Connector
    // In each method, you can write you business and return the type method need

    public string serverVersion(string strVersion)
    {
        return _config.GetValue<string>("App:Version");
    }

    public string clientVersion(string strVersion)
    {
        // maybe save client version or check for update
        return null;
    }

    // ...
}

• Implement IWCWebMethodAsync

using RXN.AspNetCore.QuickBookSoap2Rest.Interfaces;

// ...

// The handle class take care all business when QBWC requested to server
public class WCRequestHandlerAsync : IWCWebMethodAsync
{
    // must implement all methods supporting WC Connector
    // In each method, you can write you business and return the type method need

    public async Task<string> serverVersionAsync(string strVersion)
    {
        var assembly = System.Reflection.Assembly.GetExecutingAssembly();
        var serviceVersion = assembly.GetName().Version.ToString();

        return serviceVersion;
    }

    public async Task<string> clientVersionAsync(string strVersion)
    {
        // maybe save client version or check for update
        return null;
    }

    // ...
}

Now in your Api Controller call WCController and passing WC handler to it.

Example:

using Microsoft.AspNetCore.Mvc;
using RXN.AspNetCore.QuickBookSoap2Rest;
using RXN.AspNetCore.QuickBookSoap2Rest.Interfaces;

[Route("api")]
[ApiController]
[Produces("text/xml")]
public class SyncController : ControllerBase
{
    [HttpPost]
    public Task<XElement> Handle()
    {
        var wcController = new WCController(new WCRequestHandlerAsync());

        // Request from AspNetCore <Microsoft.AspNetCore.Http.HttpRequest> Request
        // a property of Controller Base
        // Now all QBWC request will be handle and return at here
        return wcController.HandleAsync(Request);
    }
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT