ComboCurve.Api.Api.ForecastVolumesApi

All URIs are relative to https://api.combocurve.com

Method	HTTP request	Description
GetRootForecastDailyVolumes	GET /v1/forecast-daily-volumes	Returns a list of forecast volumes
GetRootForecastMonthlyVolumes	GET /v1/forecast-monthly-volumes	Returns a list of forecast volumes
HeadRootForecastDailyVolumes	HEAD /v1/forecast-daily-volumes	Returns metadata about the existing forecast volumes
HeadRootForecastMonthlyVolumes	HEAD /v1/forecast-monthly-volumes	Returns metadata about the existing forecast volumes

GetRootForecastDailyVolumes

ICollection<ForecastVolumes> GetRootForecastDailyVolumes (string project = null, string forecast = null, string well = null, int? skip = null, int? take = null, DateTimeOffset? startDate = null, DateTimeOffset? endDate = null)

Returns a list of forecast volumes

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetRootForecastDailyVolumesExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ForecastVolumesApi(serviceAccount, apiKey);

            var project = new string[] { "project_example" };  // IEnumerable<string> | filter by project (optional)
            var forecast = new string[] { "forecast_example" };  // IEnumerable<string> | filter by forecast (optional)
            var well = new string[] { "well_example" };  // IEnumerable<string> | filter by well (optional)
            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 25) (between 1 and 200)
            var startDate = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by startDate. Returns all records with a startDate greater than or equal to the specified value. (optional)
            var endDate = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by endDate. Returns all records with a endDate less than or equal to the specified value. (optional)

            try
            {
                // Returns a list of forecast volumes
                ICollection<ForecastVolumes> result = apiInstance.GetRootForecastDailyVolumes(project, forecast, well, skip, take, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ForecastVolumesApi.GetRootForecastDailyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
project	string	filter by project	[optional]
forecast	string	filter by forecast	[optional]
well	string	filter by well	[optional]
skip	int?	number of items to skip	[optional] [default to 0]
take	int?	max records to return	[optional] [default to 25] [between 1 and 200]
startDate	DateTimeOffset?	filter by startDate. Returns all records with a startDate greater than or equal to the specified value.	[optional]
endDate	DateTimeOffset?	filter by endDate. Returns all records with a endDate less than or equal to the specified value.	[optional]

Return type

ICollection<ForecastVolumes>

Authorization

API Key, Service Account

HTTP request headers

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

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | Bad Request. There is something wrong with the request data. | - |

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

GetRootForecastMonthlyVolumes

ICollection<ForecastVolumes> GetRootForecastMonthlyVolumes (string project = null, string forecast = null, string well = null, int? skip = null, int? take = null, DateTimeOffset? startDate = null, DateTimeOffset? endDate = null)

Returns a list of forecast volumes

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetRootForecastMonthlyVolumesExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ForecastVolumesApi(serviceAccount, apiKey);

            var project = new string[] { "project_example" };  // IEnumerable<string> | filter by project (optional)
            var forecast = new string[] { "forecast_example" };  // IEnumerable<string> | filter by forecast (optional)
            var well = new string[] { "well_example" };  // IEnumerable<string> | filter by well (optional)
            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 25) (between 1 and 200)
            var startDate = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by startDate. Returns all records with a startDate greater than or equal to the specified value. (optional)
            var endDate = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by endDate. Returns all records with a endDate less than or equal to the specified value. (optional)

            try
            {
                // Returns a list of forecast volumes
                ICollection<ForecastVolumes> result = apiInstance.GetRootForecastMonthlyVolumes(project, forecast, well, skip, take, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ForecastVolumesApi.GetRootForecastMonthlyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
project	string	filter by project	[optional]
forecast	string	filter by forecast	[optional]
well	string	filter by well	[optional]
skip	int?	number of items to skip	[optional] [default to 0]
take	int?	max records to return	[optional] [default to 25] [between 1 and 200]
startDate	DateTimeOffset?	filter by startDate. Returns all records with a startDate greater than or equal to the specified value.	[optional]
endDate	DateTimeOffset?	filter by endDate. Returns all records with a endDate less than or equal to the specified value.	[optional]

Return type

ICollection<ForecastVolumes>

Authorization

API Key, Service Account

HTTP request headers

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

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | Bad Request. There is something wrong with the request data. | - |

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

HeadRootForecastDailyVolumes

void HeadRootForecastDailyVolumes (string project = null, string forecast = null, string well = null)

Returns metadata about the existing forecast volumes

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class HeadRootForecastDailyVolumesExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ForecastVolumesApi(serviceAccount, apiKey);

            var project = new string[] { "project_example" };  // IEnumerable<string> | filter by project (optional)
            var forecast = new string[] { "forecast_example" };  // IEnumerable<string> | filter by forecast (optional)
            var well = new string[] { "well_example" };  // IEnumerable<string> | filter by well (optional)

            try
            {
                // Returns metadata about the existing forecast volumes
                apiInstance.HeadRootForecastDailyVolumes(project, forecast, well);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ForecastVolumesApi.HeadRootForecastDailyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
project	string	filter by project	[optional]
forecast	string	filter by forecast	[optional]
well	string	filter by well	[optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * X-Query-Count - The number of records in this resource. When filters are provided only matching records are counted.
* Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | Bad Request. There is something wrong with the request data. | - |

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

HeadRootForecastMonthlyVolumes

void HeadRootForecastMonthlyVolumes (string project = null, string forecast = null, string well = null)

Returns metadata about the existing forecast volumes

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class HeadRootForecastMonthlyVolumesExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ForecastVolumesApi(serviceAccount, apiKey);

            var project = new string[] { "project_example" };  // IEnumerable<string> | filter by project (optional)
            var forecast = new string[] { "forecast_example" };  // IEnumerable<string> | filter by forecast (optional)
            var well = new string[] { "well_example" };  // IEnumerable<string> | filter by well (optional)

            try
            {
                // Returns metadata about the existing forecast volumes
                apiInstance.HeadRootForecastMonthlyVolumes(project, forecast, well);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ForecastVolumesApi.HeadRootForecastMonthlyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
project	string	filter by project	[optional]
forecast	string	filter by forecast	[optional]
well	string	filter by well	[optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * X-Query-Count - The number of records in this resource. When filters are provided only matching records are counted.
* Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | Bad Request. There is something wrong with the request data. | - |

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