combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

View the Project on GitHub insidepetroleum/combocurve-client-csharp

ComboCurve.Api.Api.DailyVolumesApi

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

Method HTTP request Description
GetForecastDailyVolumes GET /v1/projects/{projectId}/forecasts/{forecastId}/daily-volumes Returns a list of forecast volumes scoped to projectId project, forecastId forecast, and well.
GetForecastMonthlyVolumes GET /v1/projects/{projectId}/forecasts/{forecastId}/monthly-volumes Returns a list of forecast volumes scoped to projectId project, forecastId forecast, and well.
HeadForecastDailyVolumes HEAD /v1/projects/{projectId}/forecasts/{forecastId}/daily-volumes Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well.
HeadForecastMonthlyVolumes HEAD /v1/projects/{projectId}/forecasts/{forecastId}/monthly-volumes Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well.

GetForecastDailyVolumes

ICollection<ForecastVolumes> GetForecastDailyVolumes (string projectId, string forecastId, int? skip = null, int? take = null, string sort = null, string cursor = null, string well = null, DateTimeOffset? startDate = null, DateTimeOffset? endDate = null)

Returns a list of forecast volumes scoped to projectId project, forecastId forecast, and well.

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 GetForecastDailyVolumesExample
    {
        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 DailyVolumesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var forecastId = "forecastId_example";  // string | 
            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 sort = "sort_example";  // string | field to sort by, including + or - at the beginning for ascending or descending order, respectively (optional)
            var cursor = "cursor_example";  // string | used in pagination to get the next page (optional)
            var well = "well_example";  // string | filter by well (optional)
            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 scoped to projectId project, forecastId forecast, and well.
                ICollection<ForecastVolumes> result = apiInstance.GetForecastDailyVolumes(projectId, forecastId, skip, take, sort, cursor, well, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DailyVolumesApi.GetForecastDailyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
forecastId string    
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]
sort string field to sort by, including + or - at the beginning for ascending or descending order, respectively [optional]
cursor string used in pagination to get the next page [optional]
well string filter by well [optional]
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

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]

GetForecastMonthlyVolumes

ICollection<ForecastVolumes> GetForecastMonthlyVolumes (string projectId, string forecastId, int? skip = null, int? take = null, string sort = null, string cursor = null, string well = null, DateTimeOffset? startDate = null, DateTimeOffset? endDate = null)

Returns a list of forecast volumes scoped to projectId project, forecastId forecast, and well.

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 GetForecastMonthlyVolumesExample
    {
        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 DailyVolumesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var forecastId = "forecastId_example";  // string | 
            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 sort = "sort_example";  // string | field to sort by, including + or - at the beginning for ascending or descending order, respectively (optional)
            var cursor = "cursor_example";  // string | used in pagination to get the next page (optional)
            var well = "well_example";  // string | filter by well (optional)
            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 scoped to projectId project, forecastId forecast, and well.
                ICollection<ForecastVolumes> result = apiInstance.GetForecastMonthlyVolumes(projectId, forecastId, skip, take, sort, cursor, well, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DailyVolumesApi.GetForecastMonthlyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
forecastId string    
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]
sort string field to sort by, including + or - at the beginning for ascending or descending order, respectively [optional]
cursor string used in pagination to get the next page [optional]
well string filter by well [optional]
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

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]

HeadForecastDailyVolumes

void HeadForecastDailyVolumes (string projectId, string forecastId, int? skip = null, int? take = null, string well = null)

Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well.

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 HeadForecastDailyVolumesExample
    {
        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 DailyVolumesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var forecastId = "forecastId_example";  // string | 
            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 well = "well_example";  // string | filter by well (optional)

            try
            {
                // Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well.
                apiInstance.HeadForecastDailyVolumes(projectId, forecastId, skip, take, well);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DailyVolumesApi.HeadForecastDailyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
forecastId string    
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]
well string filter by well [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

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]

HeadForecastMonthlyVolumes

void HeadForecastMonthlyVolumes (string projectId, string forecastId, int? skip = null, int? take = null, string well = null)

Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well.

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 HeadForecastMonthlyVolumesExample
    {
        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 DailyVolumesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var forecastId = "forecastId_example";  // string | 
            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 well = "well_example";  // string | filter by well (optional)

            try
            {
                // Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well.
                apiInstance.HeadForecastMonthlyVolumes(projectId, forecastId, skip, take, well);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DailyVolumesApi.HeadForecastMonthlyVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
forecastId string    
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]
well string filter by well [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

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]