combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

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

ComboCurve.Api.Api.WellCommentsApi

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

Method HTTP request Description
GetWellComments GET /v1/well-comments Returns a list of well comment documents.
HeadWellComments HEAD /v1/well-comments Returns metadata about the existing well comment documents.

GetWellComments

ICollection<WellComment> GetWellComments (int? skip = null, int? take = null, string sort = null, string cursor = null, DateTimeOffset? commentedAt = null, string forecast = null, string project = null, string well = null)

Returns a list of well comment documents.

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 GetWellCommentsExample
    {
        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 WellCommentsApi(serviceAccount, apiKey);

            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 commentedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by commentedAt (optional)
            var forecast = "forecast_example";  // string | filter by forecast (optional)
            var project = "project_example";  // string | filter by project (optional)
            var well = "well_example";  // string | filter by well (optional)

            try
            {
                // Returns a list of well comment documents.
                ICollection<WellComment> result = apiInstance.GetWellComments(skip, take, sort, cursor, commentedAt, forecast, project, well);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WellCommentsApi.GetWellComments: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
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]
commentedAt DateTimeOffset? filter by commentedAt [optional]
forecast string filter by forecast [optional]
project string filter by project [optional]
well string filter by well [optional]

Return type

ICollection<WellComment>

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]

HeadWellComments

void HeadWellComments (int? skip = null, int? take = null, DateTimeOffset? commentedAt = null, string forecast = null, string project = null, string well = null)

Returns metadata about the existing well comment documents.

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 HeadWellCommentsExample
    {
        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 WellCommentsApi(serviceAccount, apiKey);

            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 commentedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by commentedAt, can be used for incremental pull (optional)
            var forecast = "forecast_example";  // string | filter by forecast (optional)
            var project = "project_example";  // string | filter by project (optional)
            var well = "well_example";  // string | filter by well (optional)

            try
            {
                // Returns metadata about the existing well comment documents.
                apiInstance.HeadWellComments(skip, take, commentedAt, forecast, project, well);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WellCommentsApi.HeadWellComments: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
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]
commentedAt DateTimeOffset? filter by commentedAt, can be used for incremental pull [optional]
forecast string filter by forecast [optional]
project string filter by project [optional]
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]