IO.Swagger - the C# library for the Synacta

WebApi

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

• API version: v1
• SDK version: 1.0.0
• Build date: 2016-11-15T16:05:09.142Z
• Build package: class io.swagger.codegen.languages.CSharpClientCodegen For more information, please visit http://www.agile-is.de/

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

The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

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 IO.Swagger.Api;
using IO.Swagger.Client;
using Model;

Getting Started

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            var apiInstance = new AuthorizationApi();
            var id = id_example;  // string | The principal identifier.
            var authorization = authorization_example;  // string | access token

            try
            {
                // Provides a principal by his identifier.
                PrincipalSearchResult result = apiInstance.ApiAuthorizationPrincipalsByIdGet(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorizationApi.ApiAuthorizationPrincipalsByIdGet: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost/

Class	Method	HTTP request	Description
AuthorizationApi	ApiAuthorizationPrincipalsByIdGet	GET /_api/authorization/Principals/{id}	Provides a principal by his identifier.
AuthorizationApi	ApiAuthorizationPrincipalsGet	GET /_api/authorization/Principals	Gets the principals.
AuthorizationApi	ApiAuthorizationRightsGet	GET /_api/authorization/Rights	Gets the rights.
AuthorizationApi	ApiAuthorizationRolesAddGet	GET /_api/authorization/Roles/Add	Gets the role container.
AuthorizationApi	ApiAuthorizationRolesAddPut	PUT /_api/authorization/Roles/Add	Adds the role.
AuthorizationApi	ApiAuthorizationRolesByIdDelete	DELETE /_api/authorization/Roles/{id}	Deletes the role.
AuthorizationApi	ApiAuthorizationRolesByIdGet	GET /_api/authorization/Roles/{id}	Gets the role.
AuthorizationApi	ApiAuthorizationRolesByIdPost	POST /_api/authorization/Roles/{id}	Updates the role.
AuthorizationApi	ApiAuthorizationRolesGet	GET /_api/authorization/Roles	Gets the roles.
BaseApi	ApiBaseByTypeByIdAddByNewContainerTypeGet	GET /_api/base/{type}/{id}/Add/{newContainerType}	Gets the empty container.
BaseApi	ApiBaseByTypeByIdAddPut	PUT /_api/base/{type}/{id}/Add	Saves the new container.
BaseApi	ApiBaseByTypeByIdCheckinPut	PUT /_api/base/{type}/{id}/Checkin	Checkins the specified .
BaseApi	ApiBaseByTypeByIdCheckoutPut	PUT /_api/base/{type}/{id}/Checkout	Checkouts the specified .
BaseApi	ApiBaseByTypeByIdChildrenGet	GET /_api/base/{type}/{id}/Children	Gets the children of container.
BaseApi	ApiBaseByTypeByIdChildrenTypesGet	GET /_api/base/{type}/{id}/Children/Types	Gets the container types.
BaseApi	ApiBaseByTypeByIdDelete	DELETE /_api/base/{type}/{id}	Deletes the container.
BaseApi	ApiBaseByTypeByIdDocumentsGet	GET /_api/base/{type}/{id}/Documents	Gets the documents.
BaseApi	ApiBaseByTypeByIdDocumentsTypesGet	GET /_api/base/{type}/{id}/Documents/Types	Gets the documents types.
BaseApi	ApiBaseByTypeByIdGet	GET /_api/base/{type}/{id}	Gets the container by identifier.
BaseApi	ApiBaseByTypeByIdGetFileGet	GET /_api/base/{type}/{id}/GetFile	Gets the file.
BaseApi	ApiBaseByTypeByIdLookupListByLookupListNameGet	GET /_api/base/{type}/{id}/LookupList/{lookupListName}	Gets the lookup list entries.
BaseApi	ApiBaseByTypeByIdMovePost	POST /_api/base/{type}/{id}/Move	Moves the object.
BaseApi	ApiBaseByTypeByIdPost	POST /_api/base/{type}/{id}	Updates the container.
BaseApi	ApiBaseByTypeByIdUploadFilePost	POST /_api/base/{type}/{id}/UploadFile	Uploads the file.
BaseApi	ApiBaseByTypeByIdVersionsByVersionIdGet	GET /_api/base/{type}/{id}/Versions/{versionId}	Gets the version by identifier.
BaseApi	ApiBaseByTypeByIdVersionsByVersionIdGetFileGet	GET /_api/base/{type}/{id}/Versions/{versionId}/GetFile	Gets the file for version.
BaseApi	ApiBaseByTypeByIdVersionsByVersionIdRestorePost	POST /_api/base/{type}/{id}/Versions/{versionId}/Restore	Restores the version.
BaseApi	ApiBaseByTypeByIdVersionsGet	GET /_api/base/{type}/{id}/Versions	Gets the versions.
BaseApi	ApiBaseByTypeGet	GET /_api/base/{type}	Gets containers by a type.
BaseApi	ApiBaseRootGet	GET /_api/base/Root	Gets the root.
BaseApi	ApiBaseTypesGet	GET /_api/base/Types	Gets the container types.
LoggingApi	ApiLogAddGet	GET /_api/log/Add	Gets the log container.
LoggingApi	ApiLogAddPut	PUT /_api/log/Add	Adds the log.
LoggingApi	ApiLogGet	GET /_api/log	Gets all logs.
OrganisationApi	ApiOrgByIdAddGet	GET /_api/org/{id}/Add	Gets the new organisation.
OrganisationApi	ApiOrgByIdAddPut	PUT /_api/org/{id}/Add	Saves the new organisation.
OrganisationApi	ApiOrgByIdByTypeGet	GET /_api/org/{id}/{type}	Gets all containers.
OrganisationApi	ApiOrgByIdChildrenGet	GET /_api/org/{id}/Children	Gets the child organisations.
OrganisationApi	ApiOrgByIdDelete	DELETE /_api/org/{id}	Deletes the organisation.
OrganisationApi	ApiOrgByIdGet	GET /_api/org/{id}	Gets the organisation.
OrganisationApi	ApiOrgByIdMovePost	POST /_api/org/{id}/Move	Moves the organisation.
OrganisationApi	ApiOrgByIdPost	POST /_api/org/{id}	Updates the organisation.
OrganisationApi	ApiOrgByIdRecycleBinByRecycleBinIdGet	GET /_api/org/{id}/RecycleBin/{recycleBinId}	Gets the recycle bin entry.
OrganisationApi	ApiOrgByIdRecycleBinByRecycleBinIdRestorePost	POST /_api/org/{id}/RecycleBin/{recycleBinId}/Restore	Restores the recycle bin entry.
OrganisationApi	ApiOrgByIdRecycleBinGet	GET /_api/org/{id}/RecycleBin	Gets the recycle bin.
OrganisationApi	ApiOrgGet	GET /_api/org	Gets all organisations.
OrganisationApi	ApiOrgOrgTreeGet	GET /_api/org/OrgTree	Gets all organisations with childs.
SearchApi	ApiSearchGet	GET /_api/search	Executes the search.

Documentation for Models

• Model.Container
• Model.DocumentVersion
• Model.KeyValuePairStringString
• Model.Log
• Model.Organisation
• Model.PrincipalSearchResult
• Model.RecycleBinEntry
• Model.Right
• Model.Role

Documentation for Authorization

All endpoints do not require authorization.