combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

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

ComboCurve.Api.Api.CompanyWellsApi

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

Method HTTP request Description
DeleteProjectCompanyWells DELETE /v1/projects/{projectId}/company-wells Remove the company wells documents that match the given filters from the projectId scope.
GetProjectCompanyWellById GET /v1/projects/{projectId}/company-wells/{id}  
GetProjectCompanyWells GET /v1/projects/{projectId}/company-wells Returns a list of company well documents in projectId scope.
HeadProjectCompanyWells HEAD /v1/projects/{projectId}/company-wells Returns metadata about the existing company well documents in projectId scope.
PostProjectCompanyWells POST /v1/projects/{projectId}/company-wells  

DeleteProjectCompanyWells

void DeleteProjectCompanyWells (string projectId, string chosenID = null, string dataSource = null, string id = null)

Remove the company wells documents that match the given filters from the projectId scope.

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 DeleteProjectCompanyWellsExample
    {
        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 CompanyWellsApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var chosenID = new string[] { "chosenID_example" };  // IEnumerable<string> | filter by chosenID (optional)
            var dataSource = "dataSource_example";  // string | filter by dataSource (optional)
            var id = new string[] { "id_example" };  // IEnumerable<string> | filter by id (optional)

            try
            {
                // Remove the company wells documents that match the given filters from the projectId scope.
                apiInstance.DeleteProjectCompanyWells(projectId, chosenID, dataSource, id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CompanyWellsApi.DeleteProjectCompanyWells: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
chosenID string filter by chosenID [optional]
dataSource string filter by dataSource [optional]
id string filter by id [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | OK | * X-Delete-Count - The number of records that match the given filters and were deleted. | | 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]

GetProjectCompanyWellById

Well GetProjectCompanyWellById (string projectId, string id)

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 GetProjectCompanyWellByIdExample
    {
        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 CompanyWellsApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var id = "id_example";  // string | 

            try
            {
                Well result = apiInstance.GetProjectCompanyWellById(projectId, id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CompanyWellsApi.GetProjectCompanyWellById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
id string    

Return type

Well

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | - | | 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]

GetProjectCompanyWells

ICollection<Well> GetProjectCompanyWells (string projectId, int? skip = null, int? take = null, string sort = null, string cursor = null, string api10 = null, string api12 = null, string county = null, string state = null, string wellName = null, string chosenID = null, string inptID = null, string api14 = null, DateTimeOffset? createdAt = null, DateTimeOffset? updatedAt = null, string dataSource = null, string currentOperator = null)

Returns a list of company well documents in projectId scope.

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 GetProjectCompanyWellsExample
    {
        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 CompanyWellsApi(serviceAccount, apiKey);

            var projectId = "projectId_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 api10 = "api10_example";  // string | filter by api10 (optional)
            var api12 = "api12_example";  // string | filter by api12 (optional)
            var county = "county_example";  // string | filter by county (optional)
            var state = "state_example";  // string | filter by state (optional)
            var wellName = "wellName_example";  // string | filter by wellName (optional)
            var chosenID = "chosenID_example";  // string | filter by chosenID (optional)
            var inptID = "inptID_example";  // string | filter by inptID (optional)
            var api14 = "api14_example";  // string | filter by api14 (optional)
            var createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z (optional)
            var dataSource = "dataSource_example";  // string | filter by dataSource (optional)
            var currentOperator = "currentOperator_example";  // string | filter by dataSource (optional)

            try
            {
                // Returns a list of company well documents in projectId scope.
                ICollection<Well> result = apiInstance.GetProjectCompanyWells(projectId, skip, take, sort, cursor, api10, api12, county, state, wellName, chosenID, inptID, api14, createdAt, updatedAt, dataSource, currentOperator);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CompanyWellsApi.GetProjectCompanyWells: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId 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]
api10 string filter by api10 [optional]
api12 string filter by api12 [optional]
county string filter by county [optional]
state string filter by state [optional]
wellName string filter by wellName [optional]
chosenID string filter by chosenID [optional]
inptID string filter by inptID [optional]
api14 string filter by api14 [optional]
createdAt DateTimeOffset? filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z [optional]
updatedAt DateTimeOffset? filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z [optional]
dataSource string filter by dataSource [optional]
currentOperator string filter by dataSource [optional]

Return type

ICollection<Well>

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]

HeadProjectCompanyWells

void HeadProjectCompanyWells (string projectId, int? skip = null, int? take = null, string api10 = null, string api12 = null, string county = null, string state = null, string wellName = null, string chosenID = null, string inptID = null, string api14 = null, DateTimeOffset? createdAt = null, DateTimeOffset? updatedAt = null, string dataSource = null, string currentOperator = null)

Returns metadata about the existing company well documents in projectId scope.

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 HeadProjectCompanyWellsExample
    {
        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 CompanyWellsApi(serviceAccount, apiKey);

            var projectId = "projectId_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 api10 = "api10_example";  // string | filter by api10 (optional)
            var api12 = "api12_example";  // string | filter by api12 (optional)
            var county = "county_example";  // string | filter by county (optional)
            var state = "state_example";  // string | filter by state (optional)
            var wellName = "wellName_example";  // string | filter by wellName (optional)
            var chosenID = "chosenID_example";  // string | filter by chosenID (optional)
            var inptID = "inptID_example";  // string | filter by inptID (optional)
            var api14 = "api14_example";  // string | filter by api14 (optional)
            var createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z (optional)
            var dataSource = "dataSource_example";  // string | filter by dataSource (optional)
            var currentOperator = "currentOperator_example";  // string | filter by dataSource (optional)

            try
            {
                // Returns metadata about the existing company well documents in projectId scope.
                apiInstance.HeadProjectCompanyWells(projectId, skip, take, api10, api12, county, state, wellName, chosenID, inptID, api14, createdAt, updatedAt, dataSource, currentOperator);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CompanyWellsApi.HeadProjectCompanyWells: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId 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]
api10 string filter by api10 [optional]
api12 string filter by api12 [optional]
county string filter by county [optional]
state string filter by state [optional]
wellName string filter by wellName [optional]
chosenID string filter by chosenID [optional]
inptID string filter by inptID [optional]
api14 string filter by api14 [optional]
createdAt DateTimeOffset? filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z [optional]
updatedAt DateTimeOffset? filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z [optional]
dataSource string filter by dataSource [optional]
currentOperator string filter by dataSource [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]

PostProjectCompanyWells

CompanyWellMultiStatusResponse PostProjectCompanyWells (string projectId, List well = null)

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 PostProjectCompanyWellsExample
    {
        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 CompanyWellsApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var well = new List<CompanyWellInput>(); // List<CompanyWellInput> | Company Well documents to insert. See CompanyWellInputList. (optional) 

            try
            {
                CompanyWellMultiStatusResponse result = apiInstance.PostProjectCompanyWells(projectId, well);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CompanyWellsApi.PostProjectCompanyWells: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
well List<CompanyWellInput> Company Well documents to insert. See CompanyWellInputList. [optional] [Max number of items is 1000]

Return type

CompanyWellMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 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]