Skip to content

PublicServicesApi.md

Latest commit

 

History

History
503 lines (349 loc) · 13.6 KB

PublicServicesApi.md

File metadata and controls

503 lines (349 loc) · 13.6 KB

Id4iApi.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(organizationId, id4n, fileName)

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

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var organizationId = "organizationId_example"; // String | organizationId

var id4n = "id4n_example"; // String | id4n

var fileName = "fileName_example"; // String | fileName


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPublicDocument(organizationId, id4n, fileName, callback);

Parameters

Name Type Description Notes
organizationId String organizationId
id4n String id4n
fileName String fileName

Return type

Document

Authorization

Authorization

HTTP request headers

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

getRoutes

[Route] getRoutes(id4n, type, opts)

Retrieve all public routes for a GUID

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var id4n = "id4n_example"; // String | id4n

var type = "web"; // String | type

var opts = { 
  'interpolate': true // Boolean | interpolate
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getRoutes(id4n, type, opts, callback);

Parameters

Name Type Description Notes
id4n String id4n
type String type [default to web]
interpolate Boolean interpolate [optional] [default to true]

Return type

[Route]

Authorization

Authorization

HTTP request headers

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

go

go(guid)

Forward

Forwarding to the designated route defined in the routing,

Example

var Id4iApi = require('id4i_api');

var apiInstance = new Id4iApi.PublicServicesApi();

var guid = "guid_example"; // String | guid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.go(guid, callback);

Parameters

Name Type Description Notes
guid String guid

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

listAllPublicDocuments

PaginatedResponseOfDocument listAllPublicDocuments(id4n, opts)

List public documents

Listing all public documents of an id4n

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var id4n = "id4n_example"; // String | id4n

var opts = { 
  'organizationId': "organizationId_example", // String | organizationId
  'owner': "owner_example", // String | Filter by owner organization
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listAllPublicDocuments(id4n, opts, callback);

Parameters

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

Return type

PaginatedResponseOfDocument

Authorization

Authorization

HTTP request headers

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

listPublicHistory

PaginatedResponseOfHistoryItem listPublicHistory(id4n, opts)

Shows the public history of the given GUID

Only contains public history items

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listPublicHistory(id4n, opts, callback);

Parameters

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

Return type

PaginatedResponseOfHistoryItem

Authorization

Authorization

HTTP request headers

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

readOrganizationInfo

Organization readOrganizationInfo(organizationId)

Read public organization information

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var organizationId = "organizationId_example"; // String | Organization ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.readOrganizationInfo(organizationId, callback);

Parameters

Name Type Description Notes
organizationId String Organization ID

Return type

Organization

Authorization

Authorization

HTTP request headers

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

readPublicDocument

'Blob' readPublicDocument(organizationId, id4n, fileName)

Read public document contents

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var organizationId = "organizationId_example"; // String | organizationId

var id4n = "id4n_example"; // String | id4n

var fileName = "fileName_example"; // String | fileName


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.readPublicDocument(organizationId, id4n, fileName, callback);

Parameters

Name Type Description Notes
organizationId String organizationId
id4n String id4n
fileName String fileName

Return type

'Blob'

Authorization

Authorization

HTTP request headers

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

resolveImageUsingGET

'Blob' resolveImageUsingGET(imageID)

Resolve image

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

var apiInstance = new Id4iApi.PublicServicesApi();

var imageID = "imageID_example"; // String | The id of the image to be resolved.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.resolveImageUsingGET(imageID, callback);

Parameters

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

Return type

'Blob'

Authorization

Authorization

HTTP request headers

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

resolveWhoIsEntry

WhoIsResponse resolveWhoIsEntry(id4n)

Resolve owner of id4n

Example

var Id4iApi = require('id4i_api');

var apiInstance = new Id4iApi.PublicServicesApi();

var id4n = "id4n_example"; // String | id4n


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.resolveWhoIsEntry(id4n, callback);

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