GET WellPurposes/ByEffectiveDate?assetId={assetId}&wellPurposeTypeId={wellPurposeTypeId}&beginDate={beginDate}&endDate={endDate}
Retrieves well purposes for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| wellPurposeTypeId |
Id of the well purpose type |
globally unique identifier |
None. |
| beginDate |
Beginning effective date of the well purposes to retrieve |
date |
None. |
| endDate |
Ending effective date of the well purposes to retrieve |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of well purposes.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of WellPurpose |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"WellPurposeId": "78b89c67-4f5f-420d-8a27-a125e035478f",
"Asset": {
"AssetId": "a4f16d22-677e-4857-a62c-c3a586b83824",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dfb046a6-7549-4d57-93f7-4bed50464407",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f24f22b0-c697-4c72-a2a2-76f2649ad525",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8eb79a75-345b-403f-8bbc-8f589d8f77ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02cb4480-2bc7-43e0-9a12-c846f5f8575b",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "078b49e1-1edb-46c7-a2b4-41613e8cbf8d",
"EffectiveDate": "2026-05-11T11:33:33.5479846-07:00",
"StateType": {
"StateTypeId": "6154d865-ac96-408e-a999-24866ed72313",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "dfb046a6-7549-4d57-93f7-4bed50464407",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f24f22b0-c697-4c72-a2a2-76f2649ad525",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "76acfb2a-6386-4e2c-a240-9596a83b40cd",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "05181290-973b-4d21-9439-db90e5ff79f8",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dd5bac70-6f97-4812-ad47-2f3b94811bd4",
"EffectiveDate": "2026-05-11T11:33:33.5479846-07:00",
"StatusType": {
"StatusTypeId": "51646399-b3b7-479a-a086-e1484f274908",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "dfb046a6-7549-4d57-93f7-4bed50464407",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f24f22b0-c697-4c72-a2a2-76f2649ad525",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "11047d39-0861-4bb9-8f29-6a01fe4c8936",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "072c1fe0-4d7b-4a01-a3ab-0a980d8883c2",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dbdef1a3-d8d3-46f6-9eeb-b6a0d327484c",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-05-11T11:33:33.5479846-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0718588a-aa34-466b-8989-ad74ef5b2626",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3367d023-f06b-4b85-9e46-ee0d632b8661",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b0e629e4-3f08-4ed6-b781-f626ac55eded",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 4"
},
{
"WellPurposeId": "78b89c67-4f5f-420d-8a27-a125e035478f",
"Asset": {
"AssetId": "a4f16d22-677e-4857-a62c-c3a586b83824",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dfb046a6-7549-4d57-93f7-4bed50464407",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f24f22b0-c697-4c72-a2a2-76f2649ad525",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8eb79a75-345b-403f-8bbc-8f589d8f77ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02cb4480-2bc7-43e0-9a12-c846f5f8575b",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "078b49e1-1edb-46c7-a2b4-41613e8cbf8d",
"EffectiveDate": "2026-05-11T11:33:33.5479846-07:00",
"StateType": {
"StateTypeId": "6154d865-ac96-408e-a999-24866ed72313",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "dfb046a6-7549-4d57-93f7-4bed50464407",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f24f22b0-c697-4c72-a2a2-76f2649ad525",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "76acfb2a-6386-4e2c-a240-9596a83b40cd",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "05181290-973b-4d21-9439-db90e5ff79f8",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dd5bac70-6f97-4812-ad47-2f3b94811bd4",
"EffectiveDate": "2026-05-11T11:33:33.5479846-07:00",
"StatusType": {
"StatusTypeId": "51646399-b3b7-479a-a086-e1484f274908",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "dfb046a6-7549-4d57-93f7-4bed50464407",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f24f22b0-c697-4c72-a2a2-76f2649ad525",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "11047d39-0861-4bb9-8f29-6a01fe4c8936",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "072c1fe0-4d7b-4a01-a3ab-0a980d8883c2",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:33:33.5479846-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dbdef1a3-d8d3-46f6-9eeb-b6a0d327484c",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-05-11T11:33:33.5479846-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0718588a-aa34-466b-8989-ad74ef5b2626",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3367d023-f06b-4b85-9e46-ee0d632b8661",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b0e629e4-3f08-4ed6-b781-f626ac55eded",
"CreateDate": "2026-05-11T11:33:33.5479846-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:33:33.5479846-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}