Madaster.API.Api.ProductApi
All URIs are relative to https://localhost
Method | HTTP request | Description |
---|---|---|
ApiV11ProductsByIdChildrenGet | GET /api/v1.1/products/{id}/children | Gets the children of a product. |
ApiV11ProductsByIdChildrenPost | POST /api/v1.1/products/{id}/children | Adds a child for a product. |
ApiV11ProductsByIdChildrenPut | PUT /api/v1.1/products/{id}/children | Replaces the children for a product. |
ApiV11ProductsByIdFinancialvaluesGet | GET /api/v1.1/products/{id}/financialvalues | Gets the financial values of a product. |
ApiV11ProductsByIdFinancialvaluesPost | POST /api/v1.1/products/{id}/financialvalues | Adds a financial value for a product. |
ApiV11ProductsByIdFinancialvaluesPut | PUT /api/v1.1/products/{id}/financialvalues | Replaces the financial values for a product. |
ApiV11ProductsByIdGet | GET /api/v1.1/products/{id} | Gets a product by its identifier. |
ApiV11ProductsByIdMatchesGet | GET /api/v1.1/products/{id}/matches | Gets the matches of a product. |
ApiV11ProductsByIdMatchesPost | POST /api/v1.1/products/{id}/matches | Adds a match for a product. |
ApiV11ProductsByIdMatchesPut | PUT /api/v1.1/products/{id}/matches | Replaces the matches for a product. |
ApiV11ProductsByIdPut | PUT /api/v1.1/products/{id} | Replaces a product. |
ApiV11ProductsGet | GET /api/v1.1/products | Gets all products. |
ApiV11ProductsPost | POST /api/v1.1/products | Adds a product. |
ApiV11ProductsByIdChildrenGet
List
ApiV11ProductsByIdChildrenGet (Guid? id)
Gets the children of a product.
Sample request: GET api/[version]/products/[id]/children
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdChildrenGetExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
try
{
// Gets the children of a product.
List<ProductChild> result = apiInstance.ApiV11ProductsByIdChildrenGet(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdChildrenGet: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. |
Return type
[**List
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdChildrenPost
ProductChild ApiV11ProductsByIdChildrenPost (Guid? id, ProductChild child = null)
Adds a child for a product.
Sample request: POST api/[version]/products/[id]/children
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdChildrenPostExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
var child = new ProductChild(); // ProductChild | The child to add. (optional)
try
{
// Adds a child for a product.
ProductChild result = apiInstance.ApiV11ProductsByIdChildrenPost(id, child);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdChildrenPost: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. | |
child | ProductChild | The child to add. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdChildrenPut
List
ApiV11ProductsByIdChildrenPut (Guid? id, List children = null)
Replaces the children for a product.
Sample request: PUT api/[version]/products/[id]/children
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdChildrenPutExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
var children = new List<ProductChild>(); // List<ProductChild> | The matches to set. (optional)
try
{
// Replaces the children for a product.
List<ProductChild> result = apiInstance.ApiV11ProductsByIdChildrenPut(id, children);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdChildrenPut: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. | |
children | List<ProductChild> | The matches to set. | [optional] |
Return type
[**List
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdFinancialvaluesGet
List
ApiV11ProductsByIdFinancialvaluesGet (Guid? id)
Gets the financial values of a product.
Sample request: GET api/[version]/products/[id]/financialvalues
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdFinancialvaluesGetExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
try
{
// Gets the financial values of a product.
List<ProductFinancialValue> result = apiInstance.ApiV11ProductsByIdFinancialvaluesGet(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdFinancialvaluesGet: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. |
Return type
[**List
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdFinancialvaluesPost
ProductFinancialValue ApiV11ProductsByIdFinancialvaluesPost (Guid? id, ProductFinancialValue value = null)
Adds a financial value for a product.
Sample request: POST api/[version]/products/[id]/financialvalues
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdFinancialvaluesPostExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
var value = new ProductFinancialValue(); // ProductFinancialValue | The value to add. (optional)
try
{
// Adds a financial value for a product.
ProductFinancialValue result = apiInstance.ApiV11ProductsByIdFinancialvaluesPost(id, value);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdFinancialvaluesPost: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. | |
value | ProductFinancialValue | The value to add. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdFinancialvaluesPut
List
ApiV11ProductsByIdFinancialvaluesPut (Guid? id, List values = null)
Replaces the financial values for a product.
Sample request: PUT api/[version]/products/[id]/financialvalues
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdFinancialvaluesPutExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
var values = new List<ProductFinancialValue>(); // List<ProductFinancialValue> | The values to set. (optional)
try
{
// Replaces the financial values for a product.
List<ProductFinancialValue> result = apiInstance.ApiV11ProductsByIdFinancialvaluesPut(id, values);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdFinancialvaluesPut: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. | |
values | List<ProductFinancialValue> | The values to set. | [optional] |
Return type
[**List
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdGet
Product ApiV11ProductsByIdGet (Guid? id)
Gets a product by its identifier.
Sample request: GET api/[version]/products/[id]
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdGetExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
try
{
// Gets a product by its identifier.
Product result = apiInstance.ApiV11ProductsByIdGet(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdGet: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdMatchesGet
List
ApiV11ProductsByIdMatchesGet (Guid? id)
Gets the matches of a product.
Sample request: GET api/[version]/products/[id]/matches
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdMatchesGetExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
try
{
// Gets the matches of a product.
List<ProductMatch> result = apiInstance.ApiV11ProductsByIdMatchesGet(id);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdMatchesGet: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. |
Return type
[**List
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdMatchesPost
ProductMatch ApiV11ProductsByIdMatchesPost (Guid? id, ProductMatch match = null)
Adds a match for a product.
Sample request: POST api/[version]/products/[id]/matches
For now only Name matches are supported.
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdMatchesPostExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
var match = new ProductMatch(); // ProductMatch | The match to add. (optional)
try
{
// Adds a match for a product.
ProductMatch result = apiInstance.ApiV11ProductsByIdMatchesPost(id, match);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdMatchesPost: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. | |
match | ProductMatch | The match to add. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdMatchesPut
List
ApiV11ProductsByIdMatchesPut (Guid? id, List matches = null)
Replaces the matches for a product.
Sample request: PUT api/[version]/products/[id]/matches
For now only Name matches are supported.
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdMatchesPutExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier of the product.
var matches = new List<ProductMatch>(); // List<ProductMatch> | The matches to set. (optional)
try
{
// Replaces the matches for a product.
List<ProductMatch> result = apiInstance.ApiV11ProductsByIdMatchesPut(id, matches);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdMatchesPut: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier of the product. | |
matches | List<ProductMatch> | The matches to set. | [optional] |
Return type
[**List
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsByIdPut
Product ApiV11ProductsByIdPut (Guid? id, Product product = null)
Replaces a product.
Sample request: PUT api/[version]/products/[id]
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsByIdPutExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var id = new Guid?(); // Guid? | The identifier.
var product = new Product(); // Product | The product model. (optional)
try
{
// Replaces a product.
Product result = apiInstance.ApiV11ProductsByIdPut(id, product);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsByIdPut: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | Guid? | The identifier. | |
product | Product | The product model. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsGet
List
ApiV11ProductsGet ()
Gets all products.
Sample request: GET api/[version]/products
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsGetExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
try
{
// Gets all products.
List<Product> result = apiInstance.ApiV11ProductsGet();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsGet: " + e.Message );
}
}
}
}
Parameters
This endpoint does not need any parameter.
Return type
[**List
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV11ProductsPost
Product ApiV11ProductsPost (Product product = null)
Adds a product.
Sample request: POST api/[version]/products
Example
using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;
namespace Example
{
public class ApiV11ProductsPostExample
{
public void main()
{
// Configure API key authorization: Token
Configuration.Default.AddApiKey("X-API-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-API-Key", "Bearer");
var apiInstance = new ProductApi();
var product = new Product(); // Product | The product model. (optional)
try
{
// Adds a product.
Product result = apiInstance.ApiV11ProductsPost(product);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ProductApi.ApiV11ProductsPost: " + e.Message );
}
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
product | Product | The product model. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]