Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s3bt3r/zammad.client
Zammad Client Library for .NET
https://github.com/s3bt3r/zammad.client
csharp dotnet zammad
Last synced: 14 days ago
JSON representation
Zammad Client Library for .NET
- Host: GitHub
- URL: https://github.com/s3bt3r/zammad.client
- Owner: S3bt3r
- License: apache-2.0
- Created: 2017-09-21T15:59:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T18:49:28.000Z (about 1 year ago)
- Last Synced: 2024-11-04T11:11:32.957Z (16 days ago)
- Topics: csharp, dotnet, zammad
- Language: C#
- Size: 125 KB
- Stars: 32
- Watchers: 5
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zammad Client Library for .NET
The Zammad Client Library for .NET allows you to connect your .NET application to your Zammad instance.
## Features
- Group
- List/Get/Create/Update/Delete
- Object
- List/Get/Create/Update/Execute migration
- OnlineNotification
- List/Get/Create/Update/Delete/Mark all as read
- Organization
- List/Get/Create/Update/Delete/Search
- Tag
- List/Search/Add/Remove/List Admin/Create Admin/Rename Admin/Delete Admin
- Ticket
- List/Get/Create/Update/Delete/Search
- Ticket Article
- List/Get/Create/ListForTicket/Get Attachment
- Ticket Priority
- List/Get/Create/Update/Delete
- Ticket State
- List/Get/Create/Update/Delete
- User
- List/Get/Create/Update/Delete/Search/Get Me
## Requirements
The used target framework of Zammad Client Library for .NET is .NET Standard 2.0.
Therefore, your application's target framework must have at least .NET Framework 4.6.1, .NET Core 2.0, or .NET Standard 2.0.
[.NET Standard implementation support](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support)
## Download & Install
The Client Library ships on NuGet. You'll find the latest version and hotfixes on NuGet via the `Zammad.Client` package.
### Via Git
To get the source code of the Library via git just type:
```bash
git clone https://github.com/Asesjix/Zammad-Client.git
cd Zammad-Client
```
### Via NuGet
To get the binaries of this library ready for use within your project you can also have them installed by [NuGet](https://www.nuget.org/packages/Zammad.Client).
Package Manager
```bash
Install-Package Zammad.Client
```
.NET CLI
```bash
dotnet add package Zammad.Client
```
## Dependencies
### Newtonsoft Json
The library depend on Newtonsoft Json, which can be downloaded directly or referenced by your code project through Nuget.
- [Newtonsoft.Json](http://www.nuget.org/packages/Newtonsoft.Json)
## Code Samples
First, include the classes you need (in this case we'll include the Client and Ticket feature to demonstrate get all tickets):
```csharp
using Zammad.Client;
using Zammad.Client.Resources;
```
To perform an operation you will first instantiate a *client* which allows performing actions on it.
```csharp
var account = ZammadAccount.CreateBasicAccount("https://contoso.zammad.com", "user", "password");
var ticketClient = account.CreateTicketClient();
```
Now, to get all tickets using the client:
```csharp
var ticketList = ticketClient.GetTicketListAsync();
```
Now, to create a ticket using the client:
```csharp
var ticket = await ticketClient.CreateTicketAsync(
new Ticket
{
Title = "Help me!",
GroupId = 1,
CustomerId = 1,
OwnerId = 1,
},
new TicketArticle
{
Subject = "Help me!!!",
Body = "Nothing Work!",
Type = "note",
});
```