AroFloSharp

The AroFloSharp library provides easy access to the AroFlo API.

Supported Platforms
Getting Started
Examples
1. Usage
2. Paging
3. Where
4. Order By
Documentation
Build
Contribute
Copyright and License

Supported Platforms

.NET Standard 2.0

Getting Started

AroFloSharp is a AroFlo API client library for .NET and will be available on NuGet:

dotnet add package AroFloSharp

Examples

Usage

using var client = new AroFloSharpClient(
config =>
{
    // Provide your API Credientials
    config.SecretKey = Credentials.SECRET_KEY;
    config.UEncode   = Credentials.U_ENCODE;
    config.PEncode   = Credentials.P_ENCODE;
    config.OrgEncode = Credentials.ORG_ENCODE;
});
var response = await client.GetResponseAsync(
parameters =>
{
    parameters.AddZone(Zone.Projects);
    parameters.AddPageNumber(1);
});

var projects = JsonNetSerializer.Deserialize<ProjectZone>(response);

The above example will generate the following AroFlo request string. zone=projects&page=1 The API keys can be accessed after setting up and being approved for the AroFlo API access. By default the client returns data in Json format. But can be changed to XML with config.DataFormat.

Status & Status Message

client.Status
client.StatusMessage

You can access the status and message of the request from the client with the above.

Paging

If no page number parameter is provided, all results will be returned. By default the AroFlo API returns 500 records per request.

parameters.AddPageSize(10);

If you compare currentpageresults to maxpageresults you will know if you have to ask for the next page, incrementing pagenumber for the next query. If the value is less than the current maximum you have received the last set of data.

Where

The AndParameter and OrParameter can be used to filter the request. The comparison operator can be specified via an method overload.

parameters.AddZone(Zone.Users);
parameters.AddWhereAnd("givennames", "steve");
parameters.AddWhereOr("archived", "true");

WhereParameters can also have sub parameters that can be used for more complex comparisons.

parameters.AddZone(Zone.Tasks);
parameters.AddWhereAnd("clientname", "ClientA")
          .AddWhereOr("clientname", "ClientB");
parameters.AddWhereAnd("daterequested", "2017-12-01");

The above example would generate the following string.
zone=tasks&where=and|(|clientname|=|ClientA&where=or|clientname|=|ClientB|)&where=and|daterequested|=|2017-12-01

Order By

parameters.AddOrder("givennames");

By default the sort order is descending. This can be changed via overload.

Documentation

No documentation exists. But feel free to contribute!

Build

If you are running GitHub Desktop, you can clone this repository locally from GitHub using the "Clone in Desktop" button from the AroFloSharp project page, or run this command in your Git-enabled shell:

git clone https://github.com/puppetsw/AroFloSharp

If you are looking to contribute to the codebase, please ensure you have Visual Studio 2022 installed - you can download the Community edition from here

dotnet build ./src/AroFloSharp.Client.csproj
dotnet build ./src/AroFloSharp.Serialization.csproj

Prior to building the Client project you will need to add a file called Credentials.cs containining your API keys for AroFlo. Please don't forget to ignore this file when submitting pull requests.

public static class Credentials
{
    public const string SECRET_KEY = "";
    public const string U_ENCODE = "";
    public const string P_ENCODE = "";
    public const string ORG_ENCODE = "";
}

Contribute

Visit the Contributor Guidelines for more details. All contributors are expected to follow our Code of Conduct.