Madaster.API.Api.MaterialApi

All URIs are relative to https://localhost

Method HTTP request Description
ApiV11MaterialsByIdFinancialvaluesGet GET /api/v1.1/materials/{id}/financialvalues Gets the financial values of a material, for manual import mode.
ApiV11MaterialsByIdFinancialvaluesPost POST /api/v1.1/materials/{id}/financialvalues Adds a financial value for a material, for manual import mode.
ApiV11MaterialsByIdFinancialvaluesPut PUT /api/v1.1/materials/{id}/financialvalues Replaces the financial values for a material, for manual import mode.
ApiV11MaterialsByIdGet GET /api/v1.1/materials/{id} Gets a material by its identifier.
ApiV11MaterialsByIdMatchesGet GET /api/v1.1/materials/{id}/matches Gets the matches of a material.
ApiV11MaterialsByIdMatchesPost POST /api/v1.1/materials/{id}/matches Adds a match for a material.
ApiV11MaterialsByIdMatchesPut PUT /api/v1.1/materials/{id}/matches Replaces the matches for a material.
ApiV11MaterialsByIdPut PUT /api/v1.1/materials/{id} Replaces a material.
ApiV11MaterialsGet GET /api/v1.1/materials Gets all materials.
ApiV11MaterialsPost POST /api/v1.1/materials Adds a material.

ApiV11MaterialsByIdFinancialvaluesGet

List ApiV11MaterialsByIdFinancialvaluesGet (Guid? id)

Gets the financial values of a material, for manual import mode.

Sample request: GET api/[version]/materials/[id]/financialvalues

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsByIdFinancialvaluesGetExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.

            try
            {
                // Gets the financial values of a material, for manual import mode.
                List<MaterialFinancialValue> result = apiInstance.ApiV11MaterialsByIdFinancialvaluesGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdFinancialvaluesGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  

Return type

[**List**](/Samples/CSharp/docs/MaterialFinancialValue.html)

Authorization

Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV11MaterialsByIdFinancialvaluesPost

MaterialFinancialValue ApiV11MaterialsByIdFinancialvaluesPost (Guid? id, MaterialFinancialValue value = null)

Adds a financial value for a material, for manual import mode.

Sample request: POST api/[version]/materials/[id]/financialvalues

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsByIdFinancialvaluesPostExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.
            var value = new MaterialFinancialValue(); // MaterialFinancialValue | The value to add. (optional) 

            try
            {
                // Adds a financial value for a material, for manual import mode.
                MaterialFinancialValue result = apiInstance.ApiV11MaterialsByIdFinancialvaluesPost(id, value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdFinancialvaluesPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  
value MaterialFinancialValue The value to add. [optional]

Return type

MaterialFinancialValue

Authorization

Token

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]

ApiV11MaterialsByIdFinancialvaluesPut

List ApiV11MaterialsByIdFinancialvaluesPut (Guid? id, List values = null)

Replaces the financial values for a material, for manual import mode.

Sample request: PUT api/[version]/materials/[id]/financialvalues

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsByIdFinancialvaluesPutExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.
            var values = new List<MaterialFinancialValue>(); // List<MaterialFinancialValue> | The values to set. (optional) 

            try
            {
                // Replaces the financial values for a material, for manual import mode.
                List&lt;MaterialFinancialValue&gt; result = apiInstance.ApiV11MaterialsByIdFinancialvaluesPut(id, values);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdFinancialvaluesPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  
values List<MaterialFinancialValue> The values to set. [optional]

Return type

[**List**](/Samples/CSharp/docs/MaterialFinancialValue.html)

Authorization

Token

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]

ApiV11MaterialsByIdGet

Material ApiV11MaterialsByIdGet (Guid? id)

Gets a material by its identifier.

Sample request: GET api/[version]/materials/[id]

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsByIdGetExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.

            try
            {
                // Gets a material by its identifier.
                Material result = apiInstance.ApiV11MaterialsByIdGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  

Return type

Material

Authorization

Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV11MaterialsByIdMatchesGet

List ApiV11MaterialsByIdMatchesGet (Guid? id)

Gets the matches of a material.

Sample request: GET api/[version]/materials/[id]/matches

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsByIdMatchesGetExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.

            try
            {
                // Gets the matches of a material.
                List&lt;MaterialMatch&gt; result = apiInstance.ApiV11MaterialsByIdMatchesGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdMatchesGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  

Return type

[**List**](/Samples/CSharp/docs/MaterialMatch.html)

Authorization

Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV11MaterialsByIdMatchesPost

MaterialMatch ApiV11MaterialsByIdMatchesPost (Guid? id, MaterialMatch match = null)

Adds a match for a material.

Sample request: POST api/[version]/materials/[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 ApiV11MaterialsByIdMatchesPostExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.
            var match = new MaterialMatch(); // MaterialMatch | The match to add. (optional) 

            try
            {
                // Adds a match for a material.
                MaterialMatch result = apiInstance.ApiV11MaterialsByIdMatchesPost(id, match);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdMatchesPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  
match MaterialMatch The match to add. [optional]

Return type

MaterialMatch

Authorization

Token

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]

ApiV11MaterialsByIdMatchesPut

List ApiV11MaterialsByIdMatchesPut (Guid? id, List matches = null)

Replaces the matches for a material.

Sample request: PUT api/[version]/materials/[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 ApiV11MaterialsByIdMatchesPutExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier of the material.
            var matches = new List<MaterialMatch>(); // List<MaterialMatch> | The matches to set. (optional) 

            try
            {
                // Replaces the matches for a material.
                List&lt;MaterialMatch&gt; result = apiInstance.ApiV11MaterialsByIdMatchesPut(id, matches);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdMatchesPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier of the material.  
matches List<MaterialMatch> The matches to set. [optional]

Return type

[**List**](/Samples/CSharp/docs/MaterialMatch.html)

Authorization

Token

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]

ApiV11MaterialsByIdPut

Material ApiV11MaterialsByIdPut (Guid? id, Material material = null)

Replaces a material.

Sample request: PUT api/[version]/materials/[id]

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsByIdPutExample
    {
        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 MaterialApi();
            var id = new Guid?(); // Guid? | The identifier.
            var material = new Material(); // Material | The material model. (optional) 

            try
            {
                // Replaces a material.
                Material result = apiInstance.ApiV11MaterialsByIdPut(id, material);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsByIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid? The identifier.  
material Material The material model. [optional]

Return type

Material

Authorization

Token

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]

ApiV11MaterialsGet

List ApiV11MaterialsGet ()

Gets all materials.

Sample request: GET api/[version]/materials

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsGetExample
    {
        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 MaterialApi();

            try
            {
                // Gets all materials.
                List&lt;Material&gt; result = apiInstance.ApiV11MaterialsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[**List**](/Samples/CSharp/docs/Material.html)

Authorization

Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV11MaterialsPost

Material ApiV11MaterialsPost (Material material = null)

Adds a material.

Sample request: POST api/[version]/materials

Example

using System;
using System.Diagnostics;
using Madaster.API.Api;
using Madaster.API.Client;
using Madaster.API.Model;

namespace Example
{
    public class ApiV11MaterialsPostExample
    {
        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 MaterialApi();
            var material = new Material(); // Material | The material model. (optional) 

            try
            {
                // Adds a material.
                Material result = apiInstance.ApiV11MaterialsPost(material);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MaterialApi.ApiV11MaterialsPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
material Material The material model. [optional]

Return type

Material

Authorization

Token

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]