All URIs are relative to https://localhost/api/v5
Method | HTTP request | Description |
---|---|---|
addShopItem | POST /vshop/shop/{id}/item | Add Shop Item |
createShop | POST /vshop/shop | Create Shops |
deleteShop | DELETE /vshop/shop/{id} | Delete a Shop |
deleteShopItem | DELETE /vshop/shop/{id}/item/{item} | Removes a Shop Item |
getShop | GET /vshop/shop/{id} | Get a Shop |
getShopItem | GET /vshop/shop/{id}/item/{item} | Get a Shop |
listShopItems | GET /vshop/shop/{id}/item | List Shop Items |
listShops | GET /vshop/shop | List Shops |
updateShop | PUT /vshop/shop/{id} | Change Shop |
updateShopItem | PUT /vshop/shop/{id}/item/{item} | Change Shop Item |
VillagerShopsStockItem addShopItem(id, body, details, accept, pretty)
Add Shop Item
Add a item to the shops listing Required permissions: - vshop.vshop.item.create
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
VillagerShopsStockItem body = new VillagerShopsStockItem(); // VillagerShopsStockItem |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsStockItem result = apiInstance.addShopItem(id, body, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#addShopItem");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
body | VillagerShopsStockItem | [optional] | |
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsShop createShop(body, details, accept, pretty)
Create Shops
Spawn a new shop with base values; Some values are only set by update Required permissions: - vshop.vshop.create
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
VillagerShopsShop body = new VillagerShopsShop(); // VillagerShopsShop |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsShop result = apiInstance.createShop(body, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#createShop");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
body | VillagerShopsShop | [optional] | |
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsShop deleteShop(id, details, accept, pretty)
Delete a Shop
Permanently delete a shop from the server Required permissions: - vshop.vshop.delete
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsShop result = apiInstance.deleteShop(id, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#deleteShop");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsShop deleteShopItem(id, item, details, accept, pretty)
Removes a Shop Item
Remove an item from this shop Required permissions: - vshop.vshop.item.delete
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
Integer item = 56; // Integer |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsShop result = apiInstance.deleteShopItem(id, item, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#deleteShopItem");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
item | Integer | ||
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsShop getShop(id, details, accept, pretty)
Get a Shop
Get detailed information about a shop Required permissions: - vshop.vshop.one
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsShop result = apiInstance.getShop(id, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#getShop");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsStockItem getShopItem(id, item, details, accept, pretty)
Get a Shop
Get detailed information about a shop item Required permissions: - vshop.vshop.item.one
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
Integer item = 56; // Integer |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsStockItem result = apiInstance.getShopItem(id, item, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#getShopItem");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
item | Integer | ||
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
List<VillagerShopsStockItem> listShopItems(id, details, accept, pretty)
List Shop Items
Return a list of all shops items Required permissions: - vshop.vshop.item.list
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
List<VillagerShopsStockItem> result = apiInstance.listShopItems(id, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#listShopItems");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
List<VillagerShopsShop> listShops(details, accept, pretty)
List Shops
Return a list of all shops Required permissions: - vshop.vshop.list
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
List<VillagerShopsShop> result = apiInstance.listShops(details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#listShops");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsShop updateShop(id, body, details, accept, pretty)
Change Shop
Modifies values for this shop, but items Required permissions: - vshop.vshop.edit
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
VillagerShopsShop body = new VillagerShopsShop(); // VillagerShopsShop |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsShop result = apiInstance.updateShop(id, body, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#updateShop");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
body | VillagerShopsShop | [optional] | |
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
VillagerShopsStockItem updateShopItem(id, item, body, details, accept, pretty)
Change Shop Item
Modifies values for this shop item Required permissions: - vshop.vshop.item.edit
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VShopsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
VShopsApi apiInstance = new VShopsApi();
UUID id = new UUID(); // UUID |
Integer item = 56; // Integer |
VillagerShopsStockItem body = new VillagerShopsStockItem(); // VillagerShopsStockItem |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
VillagerShopsStockItem result = apiInstance.updateShopItem(id, item, body, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VShopsApi#updateShopItem");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | ||
item | Integer | ||
body | VillagerShopsStockItem | [optional] | |
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml