combocurve-client-csharp
C# client for the ComboCurve REST API
View the Project on GitHub insidepetroleum/combocurve-client-csharp
ComboCurve.Api.Api.WellsApi
All URIs are relative to https://api.combocurve.com
| Method | HTTP request | Description |
|---|---|---|
| DeleteWellById | DELETE /v1/wells/{id} | Delete the well document that matches the given id. |
| DeleteWells | DELETE /v1/wells | Delete the wells documents that match the given filters. |
| GetWellById | GET /v1/wells/{id} | Returns the well document that matches the given id. |
| GetWells | GET /v1/wells | Returns a list of well documents. |
| HeadWells | HEAD /v1/wells | Returns metadata about the existing well documents. |
| PatchWellById | PATCH /v1/wells/{id} | Updates the well document that matches the given id. |
| PatchWells | PATCH /v1/wells | Updates a list of well documents. |
| PostWells | POST /v1/wells | Inserts a list of well documents. |
| PutWellById | PUT /v1/wells/{id} | Replaces the well document that matches the given id. |
| PutWells | PUT /v1/wells | Replaces a list of well documents. |
DeleteWellById
void DeleteWellById (string id)
Delete the well 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 DeleteWellByIdExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var id = "id_example"; // string |
try
{
// Delete the well document that matches the given id.
apiInstance.DeleteWellById(id);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.DeleteWellById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string |
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 | |————-|————-|——————| | 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]
DeleteWells
void DeleteWells (string chosenID = null, string dataSource = null, string id = null)
Delete the wells documents that match the given filters.
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 DeleteWellsExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(serviceAccount, apiKey);
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
{
// Delete the wells documents that match the given filters.
apiInstance.DeleteWells(chosenID, dataSource, id);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.DeleteWells: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| 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
- Content-Type: Not defined
- Accept: Not defined
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]
GetWellById
Well GetWellById (string id)
Returns the well 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 GetWellByIdExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var id = "id_example"; // string |
try
{
// Returns the well document that matches the given id.
Well result = apiInstance.GetWellById(id);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.GetWellById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string |
Return type
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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetWells
ICollection<Well> GetWells (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 well 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 GetWellsExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(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 api10 = new string[] { "api10_example" }; // IEnumerable<string> | filter by api10 (optional)
var api12 = new string[] { "api12_example" }; // IEnumerable<string> | filter by api12 (optional)
var county = new string[] { "county_example" }; // IEnumerable<string> | filter by county (optional)
var state = new string[] { "state_example" }; // IEnumerable<string> | filter by state (optional)
var wellName = new string[] { "wellName_example" }; // IEnumerable<string> | filter by wellName (optional)
var chosenID = new string[] { "chosenID_example" }; // IEnumerable<string> | filter by chosenID (optional)
var inptID = "inptID_example"; // string | filter by inptID (optional)
var api14 = new string[] { "api14_example" }; // IEnumerable<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 well documents.
ICollection<Well> result = apiInstance.GetWells(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 WellsApi.GetWells: " + 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] |
| 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
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]
HeadWells
void HeadWells (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)
Returns metadata about the existing well 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 HeadWellsExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(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 api10 = new string[] { "api10_example" }; // IEnumerable<string> | filter by api10 (optional)
var api12 = new string[] { "api12_example" }; // IEnumerable<string> | filter by api12 (optional)
var county = new string[] { "county_example" }; // IEnumerable<string> | filter by county (optional)
var state = new string[] { "state_example" }; // IEnumerable<string> | filter by state (optional)
var wellName = new string[] { "wellName_example" }; // IEnumerable<string> | filter by wellName (optional)
var chosenID = new string[] { "chosenID_example" }; // IEnumerable<string> | filter by chosenID (optional)
var inptID = "inptID_example"; // string | filter by inptID (optional)
var api14 = new string[] { "api14_example" }; // IEnumerable<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)
try
{
// Returns metadata about the existing well documents.
apiInstance.HeadWells(skip, take, api10, api12, county, state, wellName, chosenID, inptID, api14, createdAt, updatedAt);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.HeadWells: " + 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] |
| 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] |
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]
PatchWellById
Well PatchWellById (string id, WellPatchInput well = null)
Updates the well 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 PatchWellByIdExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var id = "id_example"; // string |
var well = new WellPatchInput(); // WellPatchInput | (optional)
try
{
// Updates the well document that matches the given id.
Well result = apiInstance.PatchWellById(id, well);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.PatchWellById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| well | WellPatchInput | [optional] |
Return type
Authorization
API Key, Service Account
HTTP request headers
- Content-Type: application/json
- Accept: application/json
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]
PatchWells
WellMultiStatusResponse PatchWells (List
well = null)
Updates a list of well 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 PatchWellsExample
{
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);
// You can also use the specific API class
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var well = new List<WellPatchInput>(); // List<WellPatchInput> | Well documents to update. See WellPatchInputList. (optional)
try
{
// Updates a list of well documents.
WellMultiStatusResponse result = apiInstance.PatchWells(well);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.PatchWells: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| well | List<WellPatchInput> | Well documents to update. See WellPatchInputList. | [optional] [Max number of items is 1000] |
Return type
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 | - | | 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]
PostWells
WellMultiStatusResponse PostWells (List
well = null)
Inserts a list of well 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 PostWellsExample
{
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
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var well = new List<WellInput>
{
new WellInput(dataSource: "internal", chosenID: "42477310250000")
{
// For PostWells the Id will be ignored, there is no need to include it
// Id = "5e272d38b78910dd2a1bd6a8",
Api14 = "42477310250000",
Abstract = "194",
Basin = "GULF COAST CENTRAL",
County = "WASHINGTON (TX)",
CurrentOperatorAlias = "ENERVEST",
Elevation = 434,
ElevationType = "KB EST",
Field = "GIDDINGS",
FirstFluidVolume = 0,
FirstProdDate = new DateTime(2000, 1, 1),
FirstPropWeight = 0,
GroundElevation = 416,
HoleDirection = "H",
LateralLength = 5919,
LeaseName = "SWM COOP UNIT WELL",
MeasuredDepth = 0,
PerfLateralLength = 0,
Play = "EAGLEBINE",
PrimaryProduct = "OIL & GAS",
State = "TX",
Status = "EXPIRED PERMIT",
SurfaceLatitude = 30.1550863m,
SurfaceLongitude = -96.7160343m,
Survey = "PHELPS, M",
ToeLatitude = 30.1419674m,
ToeLongitude = -96.7049507m,
TrueVerticalDepth = 11500,
WellName = "SWM COOP UNIT WELL",
WellNumber = "1H",
WellType = "OIL & GAS",
Api10 = "4247731025",
Api12 = "424773102500",
Country = "US",
CurrentOperator = "ENERVEST",
District = "03",
TargetFormation = "AUSTIN CHALK, GAS,AUSTIN CHALK-3",
AcreSpacing = 0,
AllocationType = "",
AriesId = "",
Azimuth = 0,
Bg = 0,
Block = "",
Bo = 0,
BubblePointPress = 0,
CasingId = 0,
ChokeSize = 0,
CompletionDesign = "",
CompletionEndDate = new DateTime(2000, 1, 1),
CompletionStartDate = new DateTime(2000, 1, 1),
CurrentOperatorCode = "",
CurrentOperatorTicker = "",
CustomBool0 = false,
CustomBool1 = false,
CustomBool2 = false,
CustomBool3 = false,
CustomBool4 = false,
CustomDate0 = new DateTime(2000, 1, 1),
CustomDate1 = new DateTime(2000, 1, 1),
CustomDate2 = new DateTime(2000, 1, 1),
CustomDate3 = new DateTime(2000, 1, 1),
CustomDate4 = new DateTime(2000, 1, 1),
CustomDate5 = new DateTime(2000, 1, 1),
CustomDate6 = new DateTime(2000, 1, 1),
CustomDate7 = new DateTime(2000, 1, 1),
CustomDate8 = new DateTime(2000, 1, 1),
CustomDate9 = new DateTime(2000, 1, 1),
CustomNumber0 = 0,
CustomNumber1 = 0,
CustomNumber2 = 0,
CustomNumber3 = 0,
CustomNumber4 = 0,
CustomNumber5 = 0,
CustomNumber6 = 0,
CustomNumber7 = 0,
CustomNumber8 = 0,
CustomNumber9 = 0,
CustomString0 = "",
CustomString1 = "",
CustomString2 = "",
CustomString3 = "",
CustomString4 = "",
CustomString5 = "",
CustomString6 = "",
CustomString7 = "",
CustomString8 = "",
CustomString9 = "",
DataSourceCustomName = "",
DateRigRelease = new DateTime(2000, 1, 1),
DewPointPress = 0,
DistanceFromBaseOfZone = 0,
DistanceFromTopOfZone = 0,
DrainageArea = 0,
DrillEndDate = new DateTime(2000, 1, 1),
DrillinginfoId = "",
DrillStartDate = new DateTime(2000, 1, 1),
FirstAdditiveVolume = 0,
FirstClusterCount = 0,
FirstFracVendor = "",
FirstMaxInjectionPressure = 0,
FirstMaxInjectionRate = 0,
FirstStageCount = 0,
FirstTestFlowTbgPress = 0,
FirstTestGasVol = 0,
FirstTestGor = 0,
FirstTestOilVol = 0,
FirstTestWaterVol = 0,
FirstTreatmentType = "",
FlowPath = "",
FluidType = "",
FootageInLandingZone = 0,
FormationThicknessMean = 0,
FractureConductivity = 0,
GasAnalysisDate = new DateTime(2000, 1, 1),
GasC1 = 0,
GasC2 = 0,
GasC3 = 0,
GasCo2 = 0,
GasGatherer = "",
GasH2 = 0,
GasH2o = 0,
GasH2s = 0,
GasHe = 0,
GasIc4 = 0,
GasIc5 = 0,
GasN2 = 0,
GasNc10 = 0,
GasNc4 = 0,
GasNc5 = 0,
GasNc6 = 0,
GasNc7 = 0,
GasNc8 = 0,
GasNc9 = 0,
GasO2 = 0,
GasSpecificGravity = 0,
GrossPerforatedInterval = 0,
HeelLatitude = 0,
HeelLongitude = 0,
HorizontalSpacing = 0,
HzWellSpacingAnyZone = 0,
HzWellSpacingSameZone = 0,
IhsId = "",
InitialRespress = 0,
InitialRestemp = 0,
LandingZone = "",
LandingZoneBase = 0,
LandingZoneTop = 0,
LeaseNumber = "",
LowerPerforation = 0,
MatrixPermeability = 0,
NglGatherer = "",
NumTreatmentRecords = 0,
OilApiGravity = 0,
OilGatherer = "",
OilSpecificGravity = 0,
ParentChildAnyZone = "",
ParentChildSameZone = "",
PercentInZone = 0,
PermitDate = new DateTime(2000, 1, 1),
PhdwinId = "",
Porosity = 0,
PreviousOperator = "",
PreviousOperatorAlias = "",
PreviousOperatorCode = "",
PreviousOperatorTicker = "",
PrmsReservesCategory = "",
PrmsReservesSubCategory = "",
PrmsResourcesClass = "",
ProductionMethod = "",
ProppantMeshSize = "",
ProppantType = "",
Range = "",
RecoveryMethod = "",
RefracAdditiveVolume = 0,
RefracClusterCount = 0,
RefracDate = new DateTime(2000, 1, 1),
RefracFluidVolume = 0,
RefracFracVendor = "",
RefracMaxInjectionPressure = 0,
RefracMaxInjectionRate = 0,
RefracPropWeight = 0,
RefracStageCount = 0,
RefracTreatmentType = "",
Rs = 0,
RsegId = "",
Section = "0",
Sg = 0,
So = 0,
SpudDate = new DateTime(2000, 1, 1),
StageSpacing = 0,
Subplay = "",
Sw = 0,
TgsId = "",
Thickness = 0,
Til = new DateTime(2000, 1, 1),
ToeInLandingZone = "",
ToeUp = "",
Township = "",
TubingDepth = 0,
TubingId = 0,
TypeCurveArea = "",
UpperPerforation = 0,
VerticalSpacing = 0,
VtWellSpacingAnyZone = 0,
VtWellSpacingSameZone = 0,
Zi = 0,
}
};
try
{
// Inserts a list of well documents.
WellMultiStatusResponse result = apiInstance.PostWells(well);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.PostWells: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| well | List<WellInput> | Well documents to insert. See WellInputList. | [optional] [Max number of items is 1000] |
Return type
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 | - | | 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]
PutWellById
Well PutWellById (string id, WellInput well = null)
Replaces the well 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 PutWellByIdExample
{
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
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var id = "id_example"; // string
var well = new WellInput(dataSource: "internal", chosenID: "42477310250000")
{
// For PutWellsById the Id is ignored because it is sent as a separate parameter
// Id = "5e272d38b78910dd2a1bd6a8",
Api14 = "42477310250000",
Abstract = "194",
Basin = "GULF COAST CENTRAL",
County = "WASHINGTON (TX)",
CurrentOperatorAlias = "ENERVEST",
Elevation = 434,
ElevationType = "KB EST",
Field = "GIDDINGS",
FirstFluidVolume = 0,
FirstProdDate = new DateTime(2000, 1, 1),
FirstPropWeight = 0,
GroundElevation = 416,
HoleDirection = "H",
LateralLength = 5919,
LeaseName = "SWM COOP UNIT WELL",
MeasuredDepth = 0,
PerfLateralLength = 0,
Play = "EAGLEBINE",
PrimaryProduct = "OIL & GAS",
State = "TX",
Status = "EXPIRED PERMIT",
SurfaceLatitude = 30.1550863m,
SurfaceLongitude = -96.7160343m,
Survey = "PHELPS, M",
ToeLatitude = 30.1419674m,
ToeLongitude = -96.7049507m,
TrueVerticalDepth = 11500,
WellName = "SWM COOP UNIT WELL",
WellNumber = "1H",
WellType = "OIL & GAS",
Api10 = "4247731025",
Api12 = "424773102500",
Country = "US",
CurrentOperator = "ENERVEST",
District = "03",
TargetFormation = "AUSTIN CHALK, GAS,AUSTIN CHALK-3",
AcreSpacing = 0,
AllocationType = "",
AriesId = "",
Azimuth = 0,
Bg = 0,
Block = "",
Bo = 0,
BubblePointPress = 0,
CasingId = 0,
ChokeSize = 0,
CompletionDesign = "",
CompletionEndDate = new DateTime(2000, 1, 1),
CompletionStartDate = new DateTime(2000, 1, 1),
CurrentOperatorCode = "",
CurrentOperatorTicker = "",
CustomBool0 = false,
CustomBool1 = false,
CustomBool2 = false,
CustomBool3 = false,
CustomBool4 = false,
CustomDate0 = new DateTime(2000, 1, 1),
CustomDate1 = new DateTime(2000, 1, 1),
CustomDate2 = new DateTime(2000, 1, 1),
CustomDate3 = new DateTime(2000, 1, 1),
CustomDate4 = new DateTime(2000, 1, 1),
CustomDate5 = new DateTime(2000, 1, 1),
CustomDate6 = new DateTime(2000, 1, 1),
CustomDate7 = new DateTime(2000, 1, 1),
CustomDate8 = new DateTime(2000, 1, 1),
CustomDate9 = new DateTime(2000, 1, 1),
CustomNumber0 = 0,
CustomNumber1 = 0,
CustomNumber2 = 0,
CustomNumber3 = 0,
CustomNumber4 = 0,
CustomNumber5 = 0,
CustomNumber6 = 0,
CustomNumber7 = 0,
CustomNumber8 = 0,
CustomNumber9 = 0,
CustomString0 = "",
CustomString1 = "",
CustomString2 = "",
CustomString3 = "",
CustomString4 = "",
CustomString5 = "",
CustomString6 = "",
CustomString7 = "",
CustomString8 = "",
CustomString9 = "",
DataSourceCustomName = "",
DateRigRelease = new DateTime(2000, 1, 1),
DewPointPress = 0,
DistanceFromBaseOfZone = 0,
DistanceFromTopOfZone = 0,
DrainageArea = 0,
DrillEndDate = new DateTime(2000, 1, 1),
DrillinginfoId = "",
DrillStartDate = new DateTime(2000, 1, 1),
FirstAdditiveVolume = 0,
FirstClusterCount = 0,
FirstFracVendor = "",
FirstMaxInjectionPressure = 0,
FirstMaxInjectionRate = 0,
FirstStageCount = 0,
FirstTestFlowTbgPress = 0,
FirstTestGasVol = 0,
FirstTestGor = 0,
FirstTestOilVol = 0,
FirstTestWaterVol = 0,
FirstTreatmentType = "",
FlowPath = "",
FluidType = "",
FootageInLandingZone = 0,
FormationThicknessMean = 0,
FractureConductivity = 0,
GasAnalysisDate = new DateTime(2000, 1, 1),
GasC1 = 0,
GasC2 = 0,
GasC3 = 0,
GasCo2 = 0,
GasGatherer = "",
GasH2 = 0,
GasH2o = 0,
GasH2s = 0,
GasHe = 0,
GasIc4 = 0,
GasIc5 = 0,
GasN2 = 0,
GasNc10 = 0,
GasNc4 = 0,
GasNc5 = 0,
GasNc6 = 0,
GasNc7 = 0,
GasNc8 = 0,
GasNc9 = 0,
GasO2 = 0,
GasSpecificGravity = 0,
GrossPerforatedInterval = 0,
HeelLatitude = 0,
HeelLongitude = 0,
HorizontalSpacing = 0,
HzWellSpacingAnyZone = 0,
HzWellSpacingSameZone = 0,
IhsId = "",
InitialRespress = 0,
InitialRestemp = 0,
LandingZone = "",
LandingZoneBase = 0,
LandingZoneTop = 0,
LeaseNumber = "",
LowerPerforation = 0,
MatrixPermeability = 0,
NglGatherer = "",
NumTreatmentRecords = 0,
OilApiGravity = 0,
OilGatherer = "",
OilSpecificGravity = 0,
ParentChildAnyZone = "",
ParentChildSameZone = "",
PercentInZone = 0,
PermitDate = new DateTime(2000, 1, 1),
PhdwinId = "",
Porosity = 0,
PreviousOperator = "",
PreviousOperatorAlias = "",
PreviousOperatorCode = "",
PreviousOperatorTicker = "",
PrmsReservesCategory = "",
PrmsReservesSubCategory = "",
PrmsResourcesClass = "",
ProductionMethod = "",
ProppantMeshSize = "",
ProppantType = "",
Range = "",
RecoveryMethod = "",
RefracAdditiveVolume = 0,
RefracClusterCount = 0,
RefracDate = new DateTime(2000, 1, 1),
RefracFluidVolume = 0,
RefracFracVendor = "",
RefracMaxInjectionPressure = 0,
RefracMaxInjectionRate = 0,
RefracPropWeight = 0,
RefracStageCount = 0,
RefracTreatmentType = "",
Rs = 0,
RsegId = "",
Section = "0",
Sg = 0,
So = 0,
SpudDate = new DateTime(2000, 1, 1),
StageSpacing = 0,
Subplay = "",
Sw = 0,
TgsId = "",
Thickness = 0,
Til = new DateTime(2000, 1, 1),
ToeInLandingZone = "",
ToeUp = "",
Township = "",
TubingDepth = 0,
TubingId = 0,
TypeCurveArea = "",
UpperPerforation = 0,
VerticalSpacing = 0,
VtWellSpacingAnyZone = 0,
VtWellSpacingSameZone = 0,
Zi = 0,
};
try
{
// Replaces the well document that matches the given id.
Well result = apiInstance.PutWellById(id, well);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.PutWellById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| well | WellInput | [optional] |
Return type
Authorization
API Key, Service Account
HTTP request headers
- Content-Type: application/json
- Accept: application/json
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]
PutWells
WellMultiStatusResponse PutWells (List
well = null)
Replaces a list of well 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 PutWellsExample
{
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
// var apiInstance = new WellsApi(serviceAccount, apiKey);
var well = new List<WellInput>
{
new WellInput(dataSource: "internal", chosenID: "42477310250000")
{
Api14 = "42477310250000",
Abstract = "194",
Basin = "GULF COAST CENTRAL",
County = "WASHINGTON (TX)",
CurrentOperatorAlias = "ENERVEST",
Elevation = 434,
ElevationType = "KB EST",
Field = "GIDDINGS",
FirstFluidVolume = 0,
FirstProdDate = new DateTime(2000, 1, 1),
FirstPropWeight = 0,
GroundElevation = 416,
HoleDirection = "H",
LateralLength = 5919,
LeaseName = "SWM COOP UNIT WELL",
MeasuredDepth = 0,
PerfLateralLength = 0,
Play = "EAGLEBINE",
PrimaryProduct = "OIL & GAS",
State = "TX",
Status = "EXPIRED PERMIT",
SurfaceLatitude = 30.1550863m,
SurfaceLongitude = -96.7160343m,
Survey = "PHELPS, M",
ToeLatitude = 30.1419674m,
ToeLongitude = -96.7049507m,
TrueVerticalDepth = 11500,
WellName = "SWM COOP UNIT WELL",
WellNumber = "1H",
WellType = "OIL & GAS",
Api10 = "4247731025",
Api12 = "424773102500",
Country = "US",
CurrentOperator = "ENERVEST",
District = "03",
TargetFormation = "AUSTIN CHALK, GAS,AUSTIN CHALK-3",
AcreSpacing = 0,
AllocationType = "",
AriesId = "",
Azimuth = 0,
Bg = 0,
Block = "",
Bo = 0,
BubblePointPress = 0,
CasingId = 0,
ChokeSize = 0,
CompletionDesign = "",
CompletionEndDate = new DateTime(2000, 1, 1),
CompletionStartDate = new DateTime(2000, 1, 1),
CurrentOperatorCode = "",
CurrentOperatorTicker = "",
CustomBool0 = false,
CustomBool1 = false,
CustomBool2 = false,
CustomBool3 = false,
CustomBool4 = false,
CustomDate0 = new DateTime(2000, 1, 1),
CustomDate1 = new DateTime(2000, 1, 1),
CustomDate2 = new DateTime(2000, 1, 1),
CustomDate3 = new DateTime(2000, 1, 1),
CustomDate4 = new DateTime(2000, 1, 1),
CustomDate5 = new DateTime(2000, 1, 1),
CustomDate6 = new DateTime(2000, 1, 1),
CustomDate7 = new DateTime(2000, 1, 1),
CustomDate8 = new DateTime(2000, 1, 1),
CustomDate9 = new DateTime(2000, 1, 1),
CustomNumber0 = 0,
CustomNumber1 = 0,
CustomNumber2 = 0,
CustomNumber3 = 0,
CustomNumber4 = 0,
CustomNumber5 = 0,
CustomNumber6 = 0,
CustomNumber7 = 0,
CustomNumber8 = 0,
CustomNumber9 = 0,
CustomString0 = "",
CustomString1 = "",
CustomString2 = "",
CustomString3 = "",
CustomString4 = "",
CustomString5 = "",
CustomString6 = "",
CustomString7 = "",
CustomString8 = "",
CustomString9 = "",
DataSourceCustomName = "",
DateRigRelease = new DateTime(2000, 1, 1),
DewPointPress = 0,
DistanceFromBaseOfZone = 0,
DistanceFromTopOfZone = 0,
DrainageArea = 0,
DrillEndDate = new DateTime(2000, 1, 1),
DrillinginfoId = "",
DrillStartDate = new DateTime(2000, 1, 1),
FirstAdditiveVolume = 0,
FirstClusterCount = 0,
FirstFracVendor = "",
FirstMaxInjectionPressure = 0,
FirstMaxInjectionRate = 0,
FirstStageCount = 0,
FirstTestFlowTbgPress = 0,
FirstTestGasVol = 0,
FirstTestGor = 0,
FirstTestOilVol = 0,
FirstTestWaterVol = 0,
FirstTreatmentType = "",
FlowPath = "",
FluidType = "",
FootageInLandingZone = 0,
FormationThicknessMean = 0,
FractureConductivity = 0,
GasAnalysisDate = new DateTime(2000, 1, 1),
GasC1 = 0,
GasC2 = 0,
GasC3 = 0,
GasCo2 = 0,
GasGatherer = "",
GasH2 = 0,
GasH2o = 0,
GasH2s = 0,
GasHe = 0,
GasIc4 = 0,
GasIc5 = 0,
GasN2 = 0,
GasNc10 = 0,
GasNc4 = 0,
GasNc5 = 0,
GasNc6 = 0,
GasNc7 = 0,
GasNc8 = 0,
GasNc9 = 0,
GasO2 = 0,
GasSpecificGravity = 0,
GrossPerforatedInterval = 0,
HeelLatitude = 0,
HeelLongitude = 0,
HorizontalSpacing = 0,
HzWellSpacingAnyZone = 0,
HzWellSpacingSameZone = 0,
IhsId = "",
InitialRespress = 0,
InitialRestemp = 0,
LandingZone = "",
LandingZoneBase = 0,
LandingZoneTop = 0,
LeaseNumber = "",
LowerPerforation = 0,
MatrixPermeability = 0,
NglGatherer = "",
NumTreatmentRecords = 0,
OilApiGravity = 0,
OilGatherer = "",
OilSpecificGravity = 0,
ParentChildAnyZone = "",
ParentChildSameZone = "",
PercentInZone = 0,
PermitDate = new DateTime(2000, 1, 1),
PhdwinId = "",
Porosity = 0,
PreviousOperator = "",
PreviousOperatorAlias = "",
PreviousOperatorCode = "",
PreviousOperatorTicker = "",
PrmsReservesCategory = "",
PrmsReservesSubCategory = "",
PrmsResourcesClass = "",
ProductionMethod = "",
ProppantMeshSize = "",
ProppantType = "",
Range = "",
RecoveryMethod = "",
RefracAdditiveVolume = 0,
RefracClusterCount = 0,
RefracDate = new DateTime(2000, 1, 1),
RefracFluidVolume = 0,
RefracFracVendor = "",
RefracMaxInjectionPressure = 0,
RefracMaxInjectionRate = 0,
RefracPropWeight = 0,
RefracStageCount = 0,
RefracTreatmentType = "",
Rs = 0,
RsegId = "",
Section = "0",
Sg = 0,
So = 0,
SpudDate = new DateTime(2000, 1, 1),
StageSpacing = 0,
Subplay = "",
Sw = 0,
TgsId = "",
Thickness = 0,
Til = new DateTime(2000, 1, 1),
ToeInLandingZone = "",
ToeUp = "",
Township = "",
TubingDepth = 0,
TubingId = 0,
TypeCurveArea = "",
UpperPerforation = 0,
VerticalSpacing = 0,
VtWellSpacingAnyZone = 0,
VtWellSpacingSameZone = 0,
Zi = 0,
}
};
try
{
// Replaces a list of well documents.
WellMultiStatusResponse result = apiInstance.PutWells(well);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling WellsApi.PutWells: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| well | List<WellInput> | Well documents to replace. See WellInputList. | [optional] [Max number of items is 1000] |
Return type
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 | - | | 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]