ComboCurve.Api.Api.OwnershipQualifiersApi

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

Method	HTTP request	Description
GetOwnershipQualifiers	GET /v1/ownership-qualifiers	Returns a list of ownership qualifiers documents.
GetOwnershipQualifiersById	GET /v1/ownership-qualifiers/{id}	Returns the ownership qualifier document that matches the given id.
HeadOwnershipQualifiers	HEAD /v1/ownership-qualifiers	Returns metadata about the existing ownership qualifiers documents.
PostOwnershipQualifiers	POST /v1/ownership-qualifiers	Inserts a list of ownership qualifiers documents.
PutOwnershipQualifiers	PUT /v1/ownership-qualifiers	Replace or create a list of ownership qualifiers documents.

GetOwnershipQualifiers

ICollection<OwnershipQualifier> GetOwnershipQualifiers (int? skip = null, int? take = null, string sort = null, string cursor = null, DateTimeOffset? createdAt = null, string chosenID = null, string qualifierKey = null, DateTimeOffset? updatedAt = null, string well = null)

Returns a list of ownership qualifiers 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 GetOwnershipQualifiersExample
    {
        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 OwnershipQualifiersApi(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 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 chosenID = "chosenID_example";  // string | filter by chosenID (optional)
            var qualifierKey = "qualifierKey_example";  // string | filter by qualifierKey (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 well = "well_example";  // string | filter by well (optional)

            try
            {
                // Returns a list of ownership qualifiers documents.
                ICollection<OwnershipQualifier> result = apiInstance.GetOwnershipQualifiers(skip, take, sort, cursor, createdAt, chosenID, qualifierKey, updatedAt, well);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OwnershipQualifiersApi.GetOwnershipQualifiers: " + 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]
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]
chosenID	string	filter by chosenID	[optional]
qualifierKey	string	filter by qualifierKey	[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]
well	string	filter by well	[optional]

Return type

ICollection<OwnershipQualifier>

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]

GetOwnershipQualifiersById

OwnershipQualifier GetOwnershipQualifiersById (string id)

Returns the ownership qualifier document that matches the given 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 GetOwnershipQualifiersByIdExample
    {
        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 OwnershipQualifiersApi(serviceAccount, apiKey);

            var id = "id_example";  // string | 

            try
            {
                // Returns the ownership qualifier document that matches the given id.
                OwnershipQualifier result = apiInstance.GetOwnershipQualifiersById(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OwnershipQualifiersApi.GetOwnershipQualifiersById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string

Return type

OwnershipQualifier

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 | - | | 400 | Bad Request. There is something wrong with the request data. | - | | 404 | Not Found | - |

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

HeadOwnershipQualifiers

void HeadOwnershipQualifiers (int? skip = null, int? take = null, DateTimeOffset? createdAt = null, string chosenID = null, string qualifierKey = null, DateTimeOffset? updatedAt = null, string well = null)

Returns metadata about the existing ownership qualifiers 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 HeadOwnershipQualifiersExample
    {
        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 OwnershipQualifiersApi(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 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 chosenID = "chosenID_example";  // string | filter by chosenID (optional)
            var qualifierKey = "qualifierKey_example";  // string | filter by qualifierKey (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 well = "well_example";  // string | filter by well (optional)

            try
            {
                // Returns metadata about the existing ownership qualifiers documents.
                apiInstance.HeadOwnershipQualifiers(skip, take, createdAt, chosenID, qualifierKey, updatedAt, well);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OwnershipQualifiersApi.HeadOwnershipQualifiers: " + 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]
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]
chosenID	string	filter by chosenID	[optional]
qualifierKey	string	filter by qualifierKey	[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]
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]

PostOwnershipQualifiers

OwnershipQualifierMultiStatusResponse PostOwnershipQualifiers (List ownershipQualifiers = null)

Inserts a list of ownership qualifiers 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 PostOwnershipQualifiersExample
    {
        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 OwnershipQualifiersApi(serviceAccount, apiKey);

            var ownershipQualifiers = new List<OwnershipQualifierInput>(); // List<OwnershipQualifierInput> | Ownership Qualifier document(s) to insert. See OwnershipQualifierInputList. (optional) 

            try
            {
                // Inserts a list of ownership qualifiers documents.
                OwnershipQualifierMultiStatusResponse result = apiInstance.PostOwnershipQualifiers(ownershipQualifiers);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OwnershipQualifiersApi.PostOwnershipQualifiers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ownershipQualifiers	List<OwnershipQualifierInput>	Ownership Qualifier document(s) to insert. See OwnershipQualifierInputList.	[optional] [Max number of items is 500]

Return type

OwnershipQualifierMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - |

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

PutOwnershipQualifiers

OwnershipQualifierMultiStatusResponse PutOwnershipQualifiers (List ownershipQualifiers = null)

Replace or create a list of ownership qualifiers 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 PutOwnershipQualifiersExample
    {
        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 OwnershipQualifiersApi(serviceAccount, apiKey);

            var ownershipQualifiers = new List<OwnershipQualifierInput>(); // List<OwnershipQualifierInput> | Ownership qualifier document(s) to replace/create. See OwnershipQualifierInputList. (optional) 

            try
            {
                // Replace or create a list of ownership qualifiers documents.
                OwnershipQualifierMultiStatusResponse result = apiInstance.PutOwnershipQualifiers(ownershipQualifiers);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OwnershipQualifiersApi.PutOwnershipQualifiers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ownershipQualifiers	List<OwnershipQualifierInput>	Ownership qualifier document(s) to replace/create. See OwnershipQualifierInputList.	[optional] [Max number of items is 500]

Return type

OwnershipQualifierMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - |

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