Skip to content

Latest commit

 

History

History
310 lines (218 loc) · 8.77 KB

SposConfigsApi.md

File metadata and controls

310 lines (218 loc) · 8.77 KB

SposConfigsApi

All URIs are relative to /

Method HTTP request Description
createSposConfig POST /spos-configs Create a new SposConfig and set all corresponding details.
deleteSposConfig DELETE /spos-configs/{sposConfigId} Delete a certain SposConfig. All data is deleted. Deletion SHALL ...
getSposConfig GET /spos-configs/{sposConfigId} Get details of a certain SposConfig.
listSposConfigRelatedServices GET /spos-configs/{sposConfigId}/services List all Services that use a certain SposConfig.
listSposConfigs GET /spos-configs List all SposConfigs of the authenticated ServiceProvider.
modifySposConfig PUT /spos-configs/{sposConfigId} Update details of an existing SposConfig.

createSposConfig

SposConfig createSposConfig(body)

Create a new SposConfig and set all corresponding details.

Create a new SposConfig and set all corresponding details.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SposConfigsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SposConfigsApi apiInstance = new SposConfigsApi();
SposConfig body = new SposConfig(); // SposConfig | 
try {
    SposConfig result = apiInstance.createSposConfig(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SposConfigsApi#createSposConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body SposConfig

Return type

SposConfig

Authorization

authToken

HTTP request headers

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

deleteSposConfig

deleteSposConfig(sposConfigId)

Delete a certain SposConfig. All data is deleted. Deletion SHALL ...

Delete a certain SposConfig. All data is deleted. Deletion SHALL only be possible if the SposConfig is not referenced in any Service and thus is not in use anywhere.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SposConfigsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SposConfigsApi apiInstance = new SposConfigsApi();
UUID sposConfigId = new UUID(); // UUID | identifier of the referred SposConfig
try {
    apiInstance.deleteSposConfig(sposConfigId);
} catch (ApiException e) {
    System.err.println("Exception when calling SposConfigsApi#deleteSposConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
sposConfigId UUID identifier of the referred SposConfig

Return type

null (empty response body)

Authorization

authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getSposConfig

SposConfig getSposConfig(sposConfigId)

Get details of a certain SposConfig.

Get details of a certain SposConfig.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SposConfigsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SposConfigsApi apiInstance = new SposConfigsApi();
UUID sposConfigId = new UUID(); // UUID | identifier of the referred SposConfig
try {
    SposConfig result = apiInstance.getSposConfig(sposConfigId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SposConfigsApi#getSposConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
sposConfigId UUID identifier of the referred SposConfig

Return type

SposConfig

Authorization

authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listSposConfigRelatedServices

List<Service> listSposConfigRelatedServices(sposConfigId)

List all Services that use a certain SposConfig.

List all Services that use a certain SposConfig.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SposConfigsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SposConfigsApi apiInstance = new SposConfigsApi();
UUID sposConfigId = new UUID(); // UUID | identifier of the referred SposConfig
try {
    List<Service> result = apiInstance.listSposConfigRelatedServices(sposConfigId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SposConfigsApi#listSposConfigRelatedServices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
sposConfigId UUID identifier of the referred SposConfig

Return type

List<Service>

Authorization

authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listSposConfigs

List<SposConfig> listSposConfigs()

List all SposConfigs of the authenticated ServiceProvider.

List all SposConfigs of the authenticated ServiceProvider.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SposConfigsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SposConfigsApi apiInstance = new SposConfigsApi();
try {
    List<SposConfig> result = apiInstance.listSposConfigs();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SposConfigsApi#listSposConfigs");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<SposConfig>

Authorization

authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

modifySposConfig

SposConfig modifySposConfig(body, sposConfigId)

Update details of an existing SposConfig.

Update details of an existing SposConfig.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SposConfigsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SposConfigsApi apiInstance = new SposConfigsApi();
SposConfig body = new SposConfig(); // SposConfig | 
UUID sposConfigId = new UUID(); // UUID | identifier of the referred SposConfig
try {
    SposConfig result = apiInstance.modifySposConfig(body, sposConfigId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SposConfigsApi#modifySposConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body SposConfig
sposConfigId UUID identifier of the referred SposConfig

Return type

SposConfig

Authorization

authToken

HTTP request headers

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