Madaster.API - the C# library for the Madaster Private API

The Madaster Private API endpoint.

This C# SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1
• SDK version: 1.0.0
• Build package: io.swagger.codegen.languages.CSharpClientCodegen For more information, please visit https://www.madaster.com

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 Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.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 Madaster.API.csproj

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

Getting Started

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            var apiInstance = new BuildingApi();
            var id = new Guid?(); // Guid? | The identifier of the building.

            try
            {
                // Gets the circular information of a building.
                string result = apiInstance.ApiV11BuildingsByIdCircularGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BuildingApi.ApiV11BuildingsByIdCircularGet: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost

Documentation for Models

• Model.BadRequestResponse
• Model.BrandLayer
• Model.BuildingFileElement
• Model.BuildingFileResponse
• Model.BuildingFileStatusResponse
• Model.BuildingFileValidation
• Model.BuildingRequest
• Model.BuildingResponse
• Model.Classification
• Model.ConflictResponse
• Model.ForbiddenResponse
• Model.IFormFile
• Model.InternalServerErrorResponse
• Model.Mapping
• Model.Material
• Model.MaterialCircularInformation
• Model.MaterialFinancialInformation
• Model.MaterialFinancialValue
• Model.MaterialMatch
• Model.MultiLingualString
• Model.MultiLingualString1
• Model.MultiLingualString2
• Model.NotFoundResponse
• Model.Phase
• Model.PortfolioRequest
• Model.PortfolioResponse
• Model.Product
• Model.ProductChild
• Model.ProductChildCircularInformation
• Model.ProductCircularInformation
• Model.ProductDimension
• Model.ProductFinancialValue
• Model.ProductMatch
• Model.UnauthorizedResponse
• Model.V11BuildingFileRequest
• Model.V11BuildingFinancialInformationRequest
• Model.V11BuildingRequest
• Model.V11CreateBuildingFileElementRequest
• Model.V11CreatePassportRequest
• Model.V11FileDownloadResponse
• Model.V11PortfolioFileRequest
• Model.V11PortfolioFileResponse
• Model.V11PortfolioFileStatusResponse
• Model.V11UserRightRequest
• Model.V11UserRightResponse
• Model.V11ValidationGraph

Documentation for Authorization

Token

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header