# ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi

All URIs are relative to *http://localhost/gemini-web/rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createApplicationSetting**](ApplicationApi.md#createApplicationSetting) | **POST** /application/application-settings | insert resource
[**deleteApplicationSetting**](ApplicationApi.md#deleteApplicationSetting) | **DELETE** /application/application-settings/{id} | delete resource
[**fullUpdateApplication**](ApplicationApi.md#fullUpdateApplication) | **PUT** /application/applications/{id} | full update of an application
[**getAllApplicationSettings**](ApplicationApi.md#getAllApplicationSettings) | **GET** /application/application-settings | get list of resources
[**getAllApplications**](ApplicationApi.md#getAllApplications) | **GET** /application/applications | get list of resources
[**getSingleApplication**](ApplicationApi.md#getSingleApplication) | **GET** /application/applications/{id} | get resource
[**getSingleApplicationSetting**](ApplicationApi.md#getSingleApplicationSetting) | **GET** /application/application-settings/{id} | get resource
[**updateApplication**](ApplicationApi.md#updateApplication) | **POST** /application/applications/{id} | perform a partial update of the resource
[**updateApplicationSetting**](ApplicationApi.md#updateApplicationSetting) | **PUT** /application/application-settings/{id} | update resource
[**updatePartialApplicationSetting**](ApplicationApi.md#updatePartialApplicationSetting) | **POST** /application/application-settings/{id} | perform a partial update of the resource


<a name="createApplicationSetting"></a>
# **createApplicationSetting**
> ApplicationSettingJson createApplicationSetting(body, opts)

insert resource

Inserts a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationSettingJson(); // ApplicationSettingJson | The item to insert.

var opts = { 
  'transactionId': "transactionId_example", // String | A unique transaction ID used for idempotent inserts.
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ApplicationSettingJson**](ApplicationSettingJson.md)| The item to insert. | 
 **transactionId** | **String**| A unique transaction ID used for idempotent inserts. | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**ApplicationSettingJson**](ApplicationSettingJson.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="deleteApplicationSetting"></a>
# **deleteApplicationSetting**
> deleteApplicationSetting(id, opts)

delete resource

Deletes a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | The ID of the resource.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteApplicationSetting(id, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="fullUpdateApplication"></a>
# **fullUpdateApplication**
> fullUpdateApplication(id, body, opts)

full update of an application

Updates an item with the given ID. The request body has to contain the whole data-object since this is a full update operation.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | The ID of the resource.

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationJson(); // ApplicationJson | The resource to update.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.fullUpdateApplication(id, body, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **body** | [**ApplicationJson**](ApplicationJson.md)| The resource to update. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="getAllApplicationSettings"></a>
# **getAllApplicationSettings**
> ApplicationSettingRestResultPage getAllApplicationSettings(opts)

get list of resources

Gets a list of resources.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var opts = { 
  'limit': 56, // Number | An integer which is the limit (max number) of returned records (used for pagination).
  'offset': 56, // Number | An integer (< list-size-1) that is the offset of the first record to transmit (used for pagination).
  'page': 56, // Number | An integer that designates the pagenumber of the first record to transmit (used for pagination).
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **Number**| An integer which is the limit (max number) of returned records (used for pagination). | [optional] 
 **offset** | **Number**| An integer (&lt; list-size-1) that is the offset of the first record to transmit (used for pagination). | [optional] 
 **page** | **Number**| An integer that designates the pagenumber of the first record to transmit (used for pagination). | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**ApplicationSettingRestResultPage**](ApplicationSettingRestResultPage.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="getAllApplications"></a>
# **getAllApplications**
> ApplicationRestResultPage getAllApplications(opts)

get list of resources

Gets a list of resources.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var opts = { 
  'limit': 56, // Number | An integer which is the limit (max number) of returned records (used for pagination).
  'offset': 56, // Number | An integer (< list-size-1) that is the offset of the first record to transmit (used for pagination).
  'page': 56, // Number | An integer that designates the pagenumber of the first record to transmit (used for pagination).
  'client': "client_example", // String | The client of the application.
  'realm': "realm_example", // String | The realm of the application.
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **Number**| An integer which is the limit (max number) of returned records (used for pagination). | [optional] 
 **offset** | **Number**| An integer (&lt; list-size-1) that is the offset of the first record to transmit (used for pagination). | [optional] 
 **page** | **Number**| An integer that designates the pagenumber of the first record to transmit (used for pagination). | [optional] 
 **client** | **String**| The client of the application. | [optional] 
 **realm** | **String**| The realm of the application. | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**ApplicationRestResultPage**](ApplicationRestResultPage.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getSingleApplication"></a>
# **getSingleApplication**
> ApplicationJson getSingleApplication(id, opts)

get resource

Gets a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | The ID of the resource

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**ApplicationJson**](ApplicationJson.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="getSingleApplicationSetting"></a>
# **getSingleApplicationSetting**
> ApplicationSettingJson getSingleApplicationSetting(id, opts)

get resource

Gets a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | The ID of the resource.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**ApplicationSettingJson**](ApplicationSettingJson.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="updateApplication"></a>
# **updateApplication**
> updateApplication(id, opts)

perform a partial update of the resource

Updates only the given values of an existing resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | 

var opts = { 
  'body': new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.JsonNode(), // JsonNode | The fields that have to be altered.
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateApplication(id, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**|  | 
 **body** | [**JsonNode**](JsonNode.md)| The fields that have to be altered. | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="updateApplicationSetting"></a>
# **updateApplicationSetting**
> updateApplicationSetting(id, body, opts)

update resource

Updates an item with the given ID. The request body has to contain the whole data-object since this is a full update operation.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | The ID of the resource.

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationSettingJson(); // ApplicationSettingJson | The resource to update.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateApplicationSetting(id, body, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **body** | [**ApplicationSettingJson**](ApplicationSettingJson.md)| The resource to update. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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

<a name="updatePartialApplicationSetting"></a>
# **updatePartialApplicationSetting**
> updatePartialApplicationSetting(id, body, opts)

perform a partial update of the resource

Updates only the given values of an existing resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

// Configure OAuth2 access token for authorization: gemini_auth
var gemini_auth = defaultClient.authentications['gemini_auth'];
gemini_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApplicationApi();

var id = 789; // Number | The ID of the item.

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.JsonNode(); // JsonNode | The partial JSON containing the fields of the item that should be updated.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updatePartialApplicationSetting(id, body, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the item. | 
 **body** | [**JsonNode**](JsonNode.md)| The partial JSON containing the fields of the item that should be updated. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

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