BlueRain.ID4i.Api.PublicServicesApi

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

Method	HTTP request	Description
GetPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a public document (meta-data only, no content)
GetRoutes	GET /api/v1/public/routes/{id4n}	Retrieve all public routes for a GUID
Go	GET /go/{guid}	Forward
ListAllPublicDocuments	GET /api/v1/public/documents/{id4n}	List public documents
ListPublicHistory	GET /api/v1/public/history/{id4n}	Shows the public history of the given GUID
ReadOrganizationInfo	GET /api/v1/public/organizations/{organizationId}	Read public organization information
ReadPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}	Read public document contents
ResolveImageUsingGET	GET /api/v1/public/image/{imageID}	Resolve image
ResolveWhoIsEntry	GET /whois/{id4n}	Resolve owner of id4n

GetPublicDocument

Document GetPublicDocument (string organizationId, string id4n, string fileName)

Retrieve a public document (meta-data only, no content)

Example

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

namespace Example
{
    public class GetPublicDocumentExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Retrieve a public document (meta-data only, no content)
                Document result = apiInstance.GetPublicDocument(organizationId, id4n, fileName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.GetPublicDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

Document

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRoutes

List GetRoutes (string id4n, string type, bool? interpolate = null)

Retrieve all public routes for a GUID

Example

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

namespace Example
{
    public class GetRoutesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var id4n = id4n_example;  // string | id4n
            var type = type_example;  // string | type (default to web)
            var interpolate = true;  // bool? | interpolate (optional)  (default to true)

            try
            {
                // Retrieve all public routes for a GUID
                List&lt;Route&gt; result = apiInstance.GetRoutes(id4n, type, interpolate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.GetRoutes: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id4n	string	id4n
type	string	type	[default to web]
interpolate	bool?	interpolate	[optional] [default to true]

Return type

List

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Go

void Go (string guid)

Forward

Forwarding to the designated route defined in the routing,

Example

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

namespace Example
{
    public class GoExample
    {
        public void main()
        {
            var apiInstance = new PublicServicesApi();
            var guid = guid_example;  // string | guid

            try
            {
                // Forward
                apiInstance.Go(guid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.Go: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
guid	string	guid

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAllPublicDocuments

PaginatedResponseOfDocument ListAllPublicDocuments (string id4n, string organizationId = null, string owner = null, int? offset = null, int? limit = null)

List public documents

Listing all public documents of an id4n

Example

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

namespace Example
{
    public class ListAllPublicDocumentsExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var id4n = id4n_example;  // string | id4n
            var organizationId = organizationId_example;  // string | organizationId (optional) 
            var owner = owner_example;  // string | Filter by owner organization (optional) 
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // List public documents
                PaginatedResponseOfDocument result = apiInstance.ListAllPublicDocuments(id4n, organizationId, owner, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.ListAllPublicDocuments: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id4n	string	id4n
organizationId	string	organizationId	[optional]
owner	string	Filter by owner organization	[optional]
offset	int?	Start with the n-th element	[optional]
limit	int?	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfDocument

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPublicHistory

PaginatedResponseOfHistoryItem ListPublicHistory (string id4n, int? offset = null, int? limit = null)

Shows the public history of the given GUID

Only contains public history items

Example

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

namespace Example
{
    public class ListPublicHistoryExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // Shows the public history of the given GUID
                PaginatedResponseOfHistoryItem result = apiInstance.ListPublicHistory(id4n, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.ListPublicHistory: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id4n	string	GUID to retrieve the history for
offset	int?	Start with the n-th element	[optional]
limit	int?	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfHistoryItem

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadOrganizationInfo

Organization ReadOrganizationInfo (string organizationId)

Read public organization information

Example

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

namespace Example
{
    public class ReadOrganizationInfoExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var organizationId = organizationId_example;  // string | Organization ID

            try
            {
                // Read public organization information
                Organization result = apiInstance.ReadOrganizationInfo(organizationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.ReadOrganizationInfo: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	Organization ID

Return type

Organization

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadPublicDocument

byte[] ReadPublicDocument (string organizationId, string id4n, string fileName)

Read public document contents

Example

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

namespace Example
{
    public class ReadPublicDocumentExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Read public document contents
                byte[] result = apiInstance.ReadPublicDocument(organizationId, id4n, fileName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.ReadPublicDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

byte[]

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResolveImageUsingGET

byte[] ResolveImageUsingGET (string imageID)

Resolve image

Example

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

namespace Example
{
    public class ResolveImageUsingGETExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new PublicServicesApi();
            var imageID = imageID_example;  // string | The id of the image to be resolved.

            try
            {
                // Resolve image
                byte[] result = apiInstance.ResolveImageUsingGET(imageID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.ResolveImageUsingGET: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
imageID	string	The id of the image to be resolved.

Return type

byte[]

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResolveWhoIsEntry

WhoIsResponse ResolveWhoIsEntry (string id4n)

Resolve owner of id4n

Example

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

namespace Example
{
    public class ResolveWhoIsEntryExample
    {
        public void main()
        {
            var apiInstance = new PublicServicesApi();
            var id4n = id4n_example;  // string | id4n

            try
            {
                // Resolve owner of id4n
                WhoIsResponse result = apiInstance.ResolveWhoIsEntry(id4n);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicServicesApi.ResolveWhoIsEntry: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id4n	string	id4n

Return type

WhoIsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

PublicServicesApi.md

Latest commit

History

PublicServicesApi.md

File metadata and controls

BlueRain.ID4i.Api.PublicServicesApi

GetPublicDocument

Example

Parameters

Return type

Authorization

HTTP request headers

GetRoutes

Example

Parameters

Return type

Authorization

HTTP request headers

Go

Example

Parameters

Return type

Authorization

HTTP request headers

ListAllPublicDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

ListPublicHistory

Example

Parameters

Return type

Authorization

HTTP request headers

ReadOrganizationInfo

Example

Parameters

Return type

Authorization

HTTP request headers

ReadPublicDocument

Example

Parameters

Return type

Authorization

HTTP request headers

ResolveImageUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

ResolveWhoIsEntry

Example

Parameters

Return type

Authorization

HTTP request headers