Skip to content

Kirkpajl/FishbowlInventory.RestApi

Repository files navigation

Fishbowl

Fishbowl Inventory REST API implementation in C#.NET

IMPORTANT NOTE:

  • The Fishbowl REST API is currently in a beta state and revisions could be made at any time in the future. The latest version of this project was tested using version 23.4.1 of the Fishbowl API.
  • I am not actively maintaining this repo project.
  • If you find issues - please reach out with a PR that would solve it. I would try to push NuGET with updates to help as soon as I can.
  • If anyone is interested to take over as maintainer - please contact

Latest NuGet Release:

This library can be used from NuGet channel:

Please note: This source and nuget are a work-in-progress. Not all API methods/calls have been included/tested.

Example Usage

Get user permissions

// Initialize the Fishbowl Inventory REST API client
using var client = new FishbowlInventoryApiClient("https://localhost:80", "REST API Test Client", "Tests the new REST API endpoints", 1234, "admin", "admin");

// Authenticate with the Fishbowl Inventory server
var userInfo = await client.LoginAsync();

if (userInfo == null) return false;

// Output User details
Console.WriteLine($"User Name:  {userInfo.FullName}");
Console.WriteLine($"Allowed Modules ({userInfo.AllowedModules.Length}):");
foreach (var module in userInfo.AllowedModules) Console.WriteLine($"  * {module}");
Console.WriteLine($"Server Version:  {userInfo.ServerVersion}");

// Terminate the Fishbowl Inventory user session
await client.LogoutAsync();

Documentation:

For further details on how to use/integrate the FishbowlInventory.RestApi package, please refer to the repository wiki page.

Fishbowl Inventory REST API .NET SDK WIKI

Issues / Bugs:

If you have a query, issues or bugs, it means that you have shown interest in this project, and I thank you for that. Feel free to ask, suggest, report issue or post a bug here in context of this library use.

Please note: If your query/issue/bug is related to Fishbowl Inventory REST API, I recommend posting it to the official Fishbowl Support forum.

You can find all of the methods to connect with me at my blog (ref. footer)

References:

Credits / Disclaimer:

  • Fishbowl Advanced logo used in this readme file is owned by and copyright of Fishbowl.
  • I am not affiliated with Fishbowl, this work is solely undertaken by me.
  • This library is not or part of the official set of libraries from Fishbowl and hence can be referred as Third party library for Fishbowl using .NET.

License

This work is licensed under:

The MIT License (MIT) Copyright (c) 2023 Josh Kirkpatrick

About

Allows for strongly-typed communication with the Fishbowl Inventory REST API using JSON.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages