ID4i API Client Library - C#

This library allows developers to interact with the http://id4i.de HTTP API. Typically you won't have to build it yourselves, you can just pull in the dependency from https://www.nuget.org/packages/BlueRain.ID4i/.

Feel free to look at the sources and the documentation contained in this repository.

For additional information, please refer to

http://id4i.de for high level information about the ID4i platform
https://backend.id4i.de/docs/reference/en/reference.html for information about implementing your own solutions on top of ID4i
https://github.com/BlueRainSoftware/id4i-api_client-csharp for this libraries sources
https://backend.id4i.de/docs/redoc/index.html for API documentation
https://github.com/BlueRainSoftware/support for getting additional support

API version: 1.0.0
Package version:
Build package: io.swagger.codegen.languages.CSharpClientCodegen

For more information, please visit http://bluerain.de

Frameworks supported

- .NET Core >=1.0
- .NET Framework >=4.6
- Mono/Xamarin >=vNext
- UWP >=10.0

Dependencies

- FubarCoder.RestSharp.Portable.Core >=4.0.7
- FubarCoder.RestSharp.Portable.HttpClient >=4.0.7
- Newtonsoft.Json >=10.0.3

Installation

Generate the DLL using your preferred tool

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

using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

Getting Started

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

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

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

    var apiInstance = new AccountsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var username = username_example;  // string | username
            var changeRoleRequest = new ChangeRoleRequest(); // ChangeRoleRequest | changeRoleRequest

    try
    {
        // Add role(s) to user
    apiInstance.AddUserRoles(organizationId, username, changeRoleRequest);
    }
    catch (Exception e)
    {
    Debug.Print("Exception when calling AccountsApi.AddUserRoles: " + e.Message );
    }

}
}
}

Documentation for API Endpoints

All URIs are relative to https://backend.id4i.de

Class	Method	HTTP request	Description
AccountsApi	AddUserRoles	POST /api/v1/organizations/{organizationId}/users/{username}/roles	Add role(s) to user
AccountsApi	CompleteRegistration	PUT /account/registration	Complete registration
AccountsApi	FindUserByUsername	GET /api/v1/users/{username}	Find by username
AccountsApi	FindUsers	GET /api/v1/users	Find users
AccountsApi	GetAllOrganizationRoles	GET /api/v1/organizations/{organizationId}/roles	List users and their roles
AccountsApi	GetOrganizationsOfUser	GET /api/v1/user/organizations	Retrieve organizations of user
AccountsApi	GetUserRoles	GET /api/v1/organizations/{organizationId}/users/{username}/roles	Get user roles by username
AccountsApi	GetUsersOfOrganization	GET /api/v1/organizations/{organizationId}/users	Find users in organization
AccountsApi	InviteUsers	POST /api/v1/organizations/{organizationId}/users/invite	Invite Users
AccountsApi	ListAllRoles	GET /api/v1/roles	List roles
AccountsApi	Login	POST /login
AccountsApi	RegisterUser	POST /account/registration	Register user
AccountsApi	RemoveUserRoles	DELETE /api/v1/organizations/{organizationId}/users/{username}/roles	Remove role(s) from user
AccountsApi	RequestPasswordReset	POST /account/password	Request password reset
AccountsApi	VerifyPasswordReset	PUT /account/password	Verify password reset
AccountsApi	VerifyUserRegistration	POST /account/verification	Verify registration
AliasApi	AddGuidAlias	POST /api/v1/id4ns/{id4n}/alias/{aliasType}	Add alias for GUID or Collection
AliasApi	GetGuidAliasTypes	GET /api/v1/search/guids/aliases/types	List all supported alias types
AliasApi	GetGuidAliases	GET /api/v1/id4ns/{id4n}/alias	Get all aliases for the given GUID or Collection.
AliasApi	RemoveGuidAlias	DELETE /api/v1/id4ns/{id4n}/alias/{aliasType}	Remove aliases from GUID or Collection
AliasApi	SearchByAlias	GET /api/v1/search/guids	Search for GUIDs by alias
ApiKeysApi	AddApiKeyPrivilege	POST /api/v1/apikeys/{key}/privileges	Add privilege
ApiKeysApi	AddApiKeyPrivilegeForId4ns	POST /api/v1/apikeys/{key}/privileges/{privilege}/id4ns	Add ID4ns of a privilege
ApiKeysApi	CreateNewApiKey	POST /api/v1/apikeys	Create API key
ApiKeysApi	DeleteApiKey	DELETE /api/v1/apikeys/{key}	Delete API key
ApiKeysApi	GetApiKey	GET /api/v1/apikeys/{key}	Show API key
ApiKeysApi	ListAllApiKeyPrivileges	GET /api/v1/apikeys/privileges	List all privileges
ApiKeysApi	ListAllApiKeysOfOrganization	GET /api/v1/apikeys	Find API key by organization
ApiKeysApi	ListApiKeyPrivileges	GET /api/v1/apikeys/{key}/privileges	List privileges
ApiKeysApi	ListId4ns	GET /api/v1/apikeys/{key}/privileges/{privilege}/id4ns	ID4ns of a privilege
ApiKeysApi	RemoveApiKeyPrivilege	DELETE /api/v1/apikeys/{key}/privileges	Remove privilege
ApiKeysApi	RemoveApiKeyPrivilegeForId4ns	DELETE /api/v1/apikeys/{key}/privileges/{privilege}/id4ns	Remove id4ns of a privilege
ApiKeysApi	UpdateApiKey	PUT /api/v1/apikeys/{key}	Update API keys
AuditingApi	ListOrganizationChangeLog	GET /api/v1/changelog/organization/{organizationId}/	List change log entries of an organization
BillingApi	GetPositionsForOrganization	GET /api/v1/billing/{organizationId}/positions	Get billing positions for a given organization
BillingApi	GetSumForOrganization	GET /api/v1/billing/{organizationId}	Get billing amount of services for a given organization
CollectionsApi	AddElementsToCollection	POST /api/v1/collections/{id4n}/elements	Add elements to collection
CollectionsApi	CreateCollection	POST /api/v1/collections	Create collection
CollectionsApi	DeleteCollection	DELETE /api/v1/collections/{id4n}	Delete collection
CollectionsApi	DeleteProperties	DELETE /api/v1/id4ns/{id4n}/properties	Delete ID4n properties
CollectionsApi	FindCollection	GET /api/v1/collections/{id4n}	Find collection
CollectionsApi	GetAllCollectionsOfOrganization	GET /api/v1/organizations/{organizationId}/collections	Get collections of organization
CollectionsApi	GetProperties	GET /api/v1/id4ns/{id4n}/properties	Retrieve ID4n properties
CollectionsApi	ListElementsOfCollection	GET /api/v1/collections/{id4n}/elements	List contents of the collection
CollectionsApi	PatchProperties	PATCH /api/v1/id4ns/{id4n}/properties	Patch ID4n properties
CollectionsApi	RemoveElementsFromCollection	DELETE /api/v1/collections/{id4n}/elements	Remove elements from collection
CollectionsApi	UpdateCollection	PATCH /api/v1/collections/{id4n}	Update collection
GuidsApi	AddGuidAlias	POST /api/v1/id4ns/{id4n}/alias/{aliasType}	Add alias for GUID or Collection
GuidsApi	CreateGuid	POST /api/v1/guids	Create GUID(s)
GuidsApi	DeleteProperties	DELETE /api/v1/id4ns/{id4n}/properties	Delete ID4n properties
GuidsApi	GetCollections	GET /api/v1/id4ns/{id4n}/collections	Retrieve collections of an ID
GuidsApi	GetGuid	GET /api/v1/guids/{id4n}	Retrieve GUID information
GuidsApi	GetGuidAliases	GET /api/v1/id4ns/{id4n}/alias	Get all aliases for the given GUID or Collection.
GuidsApi	GetGuidsWithoutCollection	GET /api/v1/guids/withoutCollection	Retrieve GUIDs not in any collection
GuidsApi	GetId4n	GET /api/v1/id4ns/{id4n}	Retrieve ID4n information
GuidsApi	GetProperties	GET /api/v1/id4ns/{id4n}/properties	Retrieve ID4n properties
GuidsApi	ImportGS1Codes	POST /api/v1/import/gs1	Import GS1/MAPP codes
GuidsApi	PatchProperties	PATCH /api/v1/id4ns/{id4n}/properties	Patch ID4n properties
GuidsApi	RemoveGuidAlias	DELETE /api/v1/id4ns/{id4n}/alias/{aliasType}	Remove aliases from GUID or Collection
GuidsApi	UpdateGuid	PATCH /api/v1/guids/{id4n}	Change GUID information.
HistoryApi	AddItem	POST /api/v1/history/{id4n}	Add history item
HistoryApi	FilteredList	GET /api/v1/history/{id4n}	List history
HistoryApi	List	GET /api/v1/history/{id4n}/{organizationId}	DEPRECATED - List history
HistoryApi	RetrieveItem	GET /api/v1/history/{id4n}/{organizationId}/{sequenceId}	Get history item
HistoryApi	UpdateItem	PATCH /api/v1/history/{id4n}/{organizationId}/{sequenceId}	Update history item
HistoryApi	UpdateItemVisibility	PUT /api/v1/history/{id4n}/{organizationId}/{sequenceId}/visibility	Set history item visibility
ImagesApi	ResolveImageUsingGET	GET /api/v1/public/image/{imageID}	Resolve image
MessagingApi	EnqueueCustomMessage	POST /api/v1/organizations/{organizationId}/messaging/enqueueCustomMessage	Enqueue a custom message
MessagingApi	GetDefaultQueue	GET /api/v1/organizations/{organizationId}/messaging
MessagingApi	PatchDefaultQueue	PATCH /api/v1/organizations/{organizationId}/messaging
MetaInformationApi	ApplicationInfo	GET /api/v1/info	Retrieve version information about ID4i
OrganizationsApi	AddPartnerOrganization	PUT /api/v1/organizations/{organizationId}/partner	Add partner
OrganizationsApi	AddUserRoles	POST /api/v1/organizations/{organizationId}/users/{username}/roles	Add role(s) to user
OrganizationsApi	CreateOrganization	POST /api/v1/organizations	Create organization
OrganizationsApi	DeleteOrganization	DELETE /api/v1/organizations/{organizationId}	Delete organization
OrganizationsApi	DeleteOrganizationBillingAddress	DELETE /api/v1/organizations/{organizationId}/addresses/billing	Remove billing address
OrganizationsApi	DeleteOrganizationLogo	DELETE /api/v1/organizations/{organizationId}/logo	Delete organization logo
OrganizationsApi	FindOrganization	GET /api/v1/organizations/{organizationId}	Find organization by id/namespace
OrganizationsApi	FindOrganizationAddress	GET /api/v1/organizations/{organizationId}/addresses/default	Retrieve address
OrganizationsApi	FindOrganizationBillingAddress	GET /api/v1/organizations/{organizationId}/addresses/billing	Retrieve billing address
OrganizationsApi	GetAllCollectionsOfOrganization	GET /api/v1/organizations/{organizationId}/collections	Get collections of organization
OrganizationsApi	GetAllOrganizationRoles	GET /api/v1/organizations/{organizationId}/roles	List users and their roles
OrganizationsApi	GetOrganizationPrivileges	GET /api/v1/organizations/{organizationId}/privileges	List my privileges
OrganizationsApi	GetOrganizationsOfUser	GET /api/v1/user/organizations	Retrieve organizations of user
OrganizationsApi	GetPartnerOrganizations	GET /api/v1/organizations/{organizationId}/partner	Get partners of an organization
OrganizationsApi	GetUserRoles	GET /api/v1/organizations/{organizationId}/users/{username}/roles	Get user roles by username
OrganizationsApi	GetUsersOfOrganization	GET /api/v1/organizations/{organizationId}/users	Find users in organization
OrganizationsApi	InviteUsers	POST /api/v1/organizations/{organizationId}/users/invite	Invite Users
OrganizationsApi	ListCountries	GET /api/v1/countries	List countries
OrganizationsApi	RemovePartnerOrganization	DELETE /api/v1/organizations/{organizationId}/partner	Remove partner
OrganizationsApi	RemoveUserRoles	DELETE /api/v1/organizations/{organizationId}/users/{username}/roles	Remove role(s) from user
OrganizationsApi	SetOrganizationLogo	POST /api/v1/organizations/{organizationId}/logo	Update organization logo
OrganizationsApi	UpdateOrganization	PUT /api/v1/organizations/{organizationId}	Update organization
OrganizationsApi	UpdateOrganizationAddress	PUT /api/v1/organizations/{organizationId}/addresses/default	Store address
OrganizationsApi	UpdateOrganizationBillingAddress	PUT /api/v1/organizations/{organizationId}/addresses/billing	Store billing address
PublicServicesApi	GetPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a public document (meta-data only, no content)
PublicServicesApi	GetRoutes	GET /api/v1/public/routes/{id4n}	Retrieve all public routes for a GUID
PublicServicesApi	Go	GET /go/{guid}	Forward
PublicServicesApi	ListAllPublicDocuments	GET /api/v1/public/documents/{id4n}	List public documents
PublicServicesApi	ListPublicHistory	GET /api/v1/public/history/{id4n}	Shows the public history of the given GUID
PublicServicesApi	ReadOrganizationInfo	GET /api/v1/public/organizations/{organizationId}	Read public organization information
PublicServicesApi	ReadPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}	Read public document contents
PublicServicesApi	ResolveImageUsingGET	GET /api/v1/public/image/{imageID}	Resolve image
PublicServicesApi	ResolveWhoIsEntry	GET /whois/{id4n}	Resolve owner of id4n
RoutingApi	GetAllRoutes	GET /api/v1/routingfiles/{id4n}/routes/{type}	Retrieve all routes of a GUID (or ID4N)
RoutingApi	GetRoute	GET /api/v1/routingfiles/{id4n}/route/{type}	Retrieve current route of a GUID (or ID4N)
RoutingApi	GetRoutingFile	GET /api/v1/routingfiles/{id4n}	Retrieve routing file
RoutingApi	UpdateRoutingFile	PUT /api/v1/routingfiles/{id4n}	Store routing file
StorageApi	CreateDocument	POST /api/v1/documents/{id4n}/{organizationId}	Create an document for an id4n
StorageApi	DeleteDocument	DELETE /api/v1/documents/{id4n}/{organizationId}/{fileName}	Delete a document
StorageApi	GetDocument	GET /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a document (meta-data only, no content)
StorageApi	GetPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a public document (meta-data only, no content)
StorageApi	ListAllDocuments	GET /api/v1/documents/{id4n}	List documents
StorageApi	ListAllPublicDocuments	GET /api/v1/public/documents/{id4n}	List public documents
StorageApi	ListDocuments	GET /api/v1/documents/{id4n}/{organizationId}	List organization specific documents
StorageApi	PutDocument	PUT /api/v1/documents/{id4n}/{organizationId}	Put an document for an id4n
StorageApi	ReadDocument	GET /api/v1/documents/{id4n}/{organizationId}/{fileName}	Read document contents
StorageApi	ReadFromMicrostorage	GET /api/v1/microstorage/{id4n}/{organization}	Read data from microstorage
StorageApi	ReadPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}	Read public document contents
StorageApi	UpdateDocumentMetadata	PATCH /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata	Update a document
StorageApi	WriteToMicrostorage	PUT /api/v1/microstorage/{id4n}/{organization}	Write data to microstorage
TransferApi	GetSendInfo	GET /api/v1/transfers/{id4n}/sendInfo	Show transfer preparation information
TransferApi	Prepare	PUT /api/v1/transfers/{id4n}/sendInfo	Prepare an object for transfer
TransferApi	Receive	PUT /api/v1/transfers/{id4n}/receiveInfo	Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership
WhoIsApi	ResolveWhoIsEntry	GET /whois/{id4n}	Resolve owner of id4n

Documentation for Models

 - [Model.AccountCredentials](docs/AccountCredentials.md)
 - [Model.AddApiKeyPrivilegeRequest](docs/AddApiKeyPrivilegeRequest.md)
 - [Model.AddPartnerRequest](docs/AddPartnerRequest.md)
 - [Model.ApiError](docs/ApiError.md)
 - [Model.ApiKeyChangeRequest](docs/ApiKeyChangeRequest.md)
 - [Model.ApiKeyCreationRequest](docs/ApiKeyCreationRequest.md)
 - [Model.ApiKeyPresentation](docs/ApiKeyPresentation.md)
 - [Model.ApiKeyPrivilege](docs/ApiKeyPrivilege.md)
 - [Model.ApiKeyPrivilegeInfo](docs/ApiKeyPrivilegeInfo.md)
 - [Model.AppInfoPresentation](docs/AppInfoPresentation.md)
 - [Model.BillingPosition](docs/BillingPosition.md)
 - [Model.ChangeLogEntry](docs/ChangeLogEntry.md)
 - [Model.ChangeRoleRequest](docs/ChangeRoleRequest.md)
 - [Model.CompleteUserRegistrationRequest](docs/CompleteUserRegistrationRequest.md)
 - [Model.Country](docs/Country.md)
 - [Model.CreateCollectionRequest](docs/CreateCollectionRequest.md)
 - [Model.CreateGuidRequest](docs/CreateGuidRequest.md)
 - [Model.Document](docs/Document.md)
 - [Model.DocumentUpdate](docs/DocumentUpdate.md)
 - [Model.Guid](docs/Guid.md)
 - [Model.GuidAlias](docs/GuidAlias.md)
 - [Model.GuidCollection](docs/GuidCollection.md)
 - [Model.HistoryItem](docs/HistoryItem.md)
 - [Model.HistoryItemUpdate](docs/HistoryItemUpdate.md)
 - [Model.Id4n](docs/Id4n.md)
 - [Model.Id4nPresentation](docs/Id4nPresentation.md)
 - [Model.ImportGS1CodesRequest](docs/ImportGS1CodesRequest.md)
 - [Model.ListOfGS1s](docs/ListOfGS1s.md)
 - [Model.ListOfId4ns](docs/ListOfId4ns.md)
 - [Model.Organization](docs/Organization.md)
 - [Model.OrganizationAddress](docs/OrganizationAddress.md)
 - [Model.OrganizationUpdate](docs/OrganizationUpdate.md)
 - [Model.OrganizationUserInvitation](docs/OrganizationUserInvitation.md)
 - [Model.OrganizationUserInvitationListRequest](docs/OrganizationUserInvitationListRequest.md)
 - [Model.PaginatedResponseOfApiKeyPresentation](docs/PaginatedResponseOfApiKeyPresentation.md)
 - [Model.PaginatedResponseOfApiKeyPrivilege](docs/PaginatedResponseOfApiKeyPrivilege.md)
 - [Model.PaginatedResponseOfApiKeyPrivilegeInfo](docs/PaginatedResponseOfApiKeyPrivilegeInfo.md)
 - [Model.PaginatedResponseOfChangeLogEntry](docs/PaginatedResponseOfChangeLogEntry.md)
 - [Model.PaginatedResponseOfCountry](docs/PaginatedResponseOfCountry.md)
 - [Model.PaginatedResponseOfDocument](docs/PaginatedResponseOfDocument.md)
 - [Model.PaginatedResponseOfGuid](docs/PaginatedResponseOfGuid.md)
 - [Model.PaginatedResponseOfGuidCollection](docs/PaginatedResponseOfGuidCollection.md)
 - [Model.PaginatedResponseOfHistoryItem](docs/PaginatedResponseOfHistoryItem.md)
 - [Model.PaginatedResponseOfId4nPresentation](docs/PaginatedResponseOfId4nPresentation.md)
 - [Model.PaginatedResponseOfOrganization](docs/PaginatedResponseOfOrganization.md)
 - [Model.PaginatedResponseOfPartnerOrganization](docs/PaginatedResponseOfPartnerOrganization.md)
 - [Model.PaginatedResponseOfRole](docs/PaginatedResponseOfRole.md)
 - [Model.PaginatedResponseOfUserPresentation](docs/PaginatedResponseOfUserPresentation.md)
 - [Model.PaginatedResponseOfUserRoles](docs/PaginatedResponseOfUserRoles.md)
 - [Model.PaginatedResponseOfstring](docs/PaginatedResponseOfstring.md)
 - [Model.PartnerOrganization](docs/PartnerOrganization.md)
 - [Model.PasswordResetRequest](docs/PasswordResetRequest.md)
 - [Model.PasswordResetVerificationRequest](docs/PasswordResetVerificationRequest.md)
 - [Model.PublicImagePresentation](docs/PublicImagePresentation.md)
 - [Model.QueuePresentation](docs/QueuePresentation.md)
 - [Model.QueueUpdateRequest](docs/QueueUpdateRequest.md)
 - [Model.RegistrationVerificationTokenPresentation](docs/RegistrationVerificationTokenPresentation.md)
 - [Model.RemoveApiKeyPrivilegeRequest](docs/RemoveApiKeyPrivilegeRequest.md)
 - [Model.RemovePartnerRequest](docs/RemovePartnerRequest.md)
 - [Model.Role](docs/Role.md)
 - [Model.Route](docs/Route.md)
 - [Model.RoutingFile](docs/RoutingFile.md)
 - [Model.RoutingFileRequest](docs/RoutingFileRequest.md)
 - [Model.RoutingOptions](docs/RoutingOptions.md)
 - [Model.SendCustomMessage](docs/SendCustomMessage.md)
 - [Model.ServiceCosts](docs/ServiceCosts.md)
 - [Model.SimpleMessageResponse](docs/SimpleMessageResponse.md)
 - [Model.TransferReceiveInfo](docs/TransferReceiveInfo.md)
 - [Model.TransferSendInfo](docs/TransferSendInfo.md)
 - [Model.UserPresentation](docs/UserPresentation.md)
 - [Model.UserRegistrationRequest](docs/UserRegistrationRequest.md)
 - [Model.UserRegistrationResponse](docs/UserRegistrationResponse.md)
 - [Model.UserRoles](docs/UserRoles.md)
 - [Model.Visibility](docs/Visibility.md)
 - [Model.VisibilityUpdate](docs/VisibilityUpdate.md)
 - [Model.WhoIsResponse](docs/WhoIsResponse.md)

Documentation for Authorization

<a name="Authorization"></a>
### Authorization

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

Name		Name	Last commit message	Last commit date
Latest commit History 32 Commits
docs		docs
src/BlueRain.ID4i		src/BlueRain.ID4i
.gitignore		.gitignore
BlueRain.ID4i.sln		BlueRain.ID4i.sln
README.md		README.md
git_push.sh		git_push.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

ID4i API Client Library - C#

Frameworks supported

Dependencies

Installation

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

About

Releases

Packages

Contributors 2

Languages

BlueRainSoftware/id4i-api_client-csharp

Folders and files

Latest commit

History

Repository files navigation

ID4i API Client Library - C#

Frameworks supported

Dependencies

Installation

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Languages

Packages