# GisServerApIs.RestrictionApi

All URIs are relative to *https://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiV1RestrictionsByRestrictionIdActionsDelete**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdActionsDelete) | **DELETE** /api/v1/restrictions/{restrictionId}/actions | 
[**apiV1RestrictionsByRestrictionIdActionsPost**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdActionsPost) | **POST** /api/v1/restrictions/{restrictionId}/actions | 
[**apiV1RestrictionsByRestrictionIdDelete**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdDelete) | **DELETE** /api/v1/restrictions/{restrictionId} | 
[**apiV1RestrictionsByRestrictionIdGet**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdGet) | **GET** /api/v1/restrictions/{restrictionId} | 
[**apiV1RestrictionsByRestrictionIdPost**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdPost) | **POST** /api/v1/restrictions/{restrictionId} | 
[**apiV1RestrictionsByRestrictionIdUsersDelete**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdUsersDelete) | **DELETE** /api/v1/restrictions/{restrictionId}/users | 
[**apiV1RestrictionsByRestrictionIdUsersPost**](RestrictionApi.md#apiV1RestrictionsByRestrictionIdUsersPost) | **POST** /api/v1/restrictions/{restrictionId}/users | 
[**apiV1RestrictionsConfigurationGet**](RestrictionApi.md#apiV1RestrictionsConfigurationGet) | **GET** /api/v1/restrictions/configuration | 
[**apiV1RestrictionsDelete**](RestrictionApi.md#apiV1RestrictionsDelete) | **DELETE** /api/v1/restrictions | 
[**apiV1RestrictionsGet**](RestrictionApi.md#apiV1RestrictionsGet) | **GET** /api/v1/restrictions | 
[**apiV1RestrictionsPost**](RestrictionApi.md#apiV1RestrictionsPost) | **POST** /api/v1/restrictions | 


<a name="apiV1RestrictionsByRestrictionIdActionsDelete"></a>
# **apiV1RestrictionsByRestrictionIdActionsDelete**
> apiV1RestrictionsByRestrictionIdActionsDelete(restrictionId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 

var opts = { 
  'actions': [new GisServerApIs.RestrictionActionResource()] // [RestrictionActionResource] | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 
 **actions** | [**[RestrictionActionResource]**](RestrictionActionResource.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: Not defined

<a name="apiV1RestrictionsByRestrictionIdActionsPost"></a>
# **apiV1RestrictionsByRestrictionIdActionsPost**
> apiV1RestrictionsByRestrictionIdActionsPost(restrictionId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 

var opts = { 
  'actions': [new GisServerApIs.RestrictionActionResource()], // [RestrictionActionResource] | 
  'mapMode': 56 // Number | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 
 **actions** | [**[RestrictionActionResource]**](RestrictionActionResource.md)|  | [optional] 
 **mapMode** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: Not defined

<a name="apiV1RestrictionsByRestrictionIdDelete"></a>
# **apiV1RestrictionsByRestrictionIdDelete**
> apiV1RestrictionsByRestrictionIdDelete(restrictionId)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="apiV1RestrictionsByRestrictionIdGet"></a>
# **apiV1RestrictionsByRestrictionIdGet**
> ResponseRestrictionResponse apiV1RestrictionsByRestrictionIdGet(restrictionId)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 

### Return type

[**ResponseRestrictionResponse**](ResponseRestrictionResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1RestrictionsByRestrictionIdPost"></a>
# **apiV1RestrictionsByRestrictionIdPost**
> ResponseRestrictionResponse apiV1RestrictionsByRestrictionIdPost(restrictionId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 

var opts = { 
  'restriction': new GisServerApIs.RestrictionResource() // RestrictionResource | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 
 **restriction** | [**RestrictionResource**](RestrictionResource.md)|  | [optional] 

### Return type

[**ResponseRestrictionResponse**](ResponseRestrictionResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1RestrictionsByRestrictionIdUsersDelete"></a>
# **apiV1RestrictionsByRestrictionIdUsersDelete**
> apiV1RestrictionsByRestrictionIdUsersDelete(restrictionId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 

var opts = { 
  'users': ["users_example"] // [String] | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 
 **users** | [**[String]**](String.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="apiV1RestrictionsByRestrictionIdUsersPost"></a>
# **apiV1RestrictionsByRestrictionIdUsersPost**
> apiV1RestrictionsByRestrictionIdUsersPost(restrictionId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var restrictionId = "restrictionId_example"; // String | 

var opts = { 
  'users': ["users_example"], // [String] | 
  'mapMode': 56 // Number | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 
 **users** | [**[String]**](String.md)|  | [optional] 
 **mapMode** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="apiV1RestrictionsConfigurationGet"></a>
# **apiV1RestrictionsConfigurationGet**
> ResponseListRestrictionActionResource apiV1RestrictionsConfigurationGet()



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**ResponseListRestrictionActionResource**](ResponseListRestrictionActionResource.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

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



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var opts = { 
  'restrictionIds': ["restrictionIds_example"] // [String] | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionIds** | [**[String]**](String.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="apiV1RestrictionsGet"></a>
# **apiV1RestrictionsGet**
> RestrictionsResponse apiV1RestrictionsGet(opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var opts = { 
  'type': "type_example", // String | 
  'offset': 56, // Number | 
  'length': 56, // Number | 
  'returnMode': 56, // Number | 
  'whereClause': "whereClause_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**|  | [optional] 
 **offset** | **Number**|  | [optional] 
 **length** | **Number**|  | [optional] 
 **returnMode** | **Number**|  | [optional] 
 **whereClause** | **String**|  | [optional] 

### Return type

[**RestrictionsResponse**](RestrictionsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1RestrictionsPost"></a>
# **apiV1RestrictionsPost**
> ResponseRestrictionResponse apiV1RestrictionsPost(opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.RestrictionApi();

var opts = { 
  'restriction': new GisServerApIs.RestrictionResource() // RestrictionResource | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restriction** | [**RestrictionResource**](RestrictionResource.md)|  | [optional] 

### Return type

[**ResponseRestrictionResponse**](ResponseRestrictionResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: text/plain, application/json, text/json