Obada.Client - the C# library for the OBADA API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://www.obada.io

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Obada.Client.Api;
using Obada.Client.Client;
using Obada.Client.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Obada.Client.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Obada.Client.Api;
using Obada.Client.Client;
using Obada.Client.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration.Default.BasePath = "http://obs.node.obada.io";
            var apiInstance = new ObitApi(Configuration.Default);
            var obit = new Obit(); // Obit |  (optional) 

            try
            {
                // Generates Obit checksum
                Checksum result = apiInstance.Checksum(obit);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ObitApi.Checksum: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://obs.node.obada.io

Class	Method	HTTP request	Description
ObitApi	Checksum	POST /obit/checksum	Generates Obit checksum
ObitApi	GenerateDID	POST /obit/did	Generate Obit DID
ObitApi	Get	GET /obits/{obit_did}	Get Obit by DID or USN
ObitApi	History	GET /obits/{obit_did}/history	Get Obit history by DID or USN
ObitApi	Save	POST /obits	Save Obit
ObitApi	Search	GET /obits	Search obits by query

Documentation for Models

• Model.Checksum
• Model.DocumentLink
• Model.InlineResponse200
• Model.InternalServerError
• Model.MetaDataRecord
• Model.NotFound
• Model.Obit
• Model.ObitDID
• Model.ObitHistory
• Model.Obits
• Model.ObitsMeta
• Model.RequestObitDID
• Model.StructureDataRecord
• Model.UnprocessableEntity
• Model.UnprocessableEntityFields

Documentation for Authorization

All endpoints do not require authorization.