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": "d9c69a3d-2d0f-45dc-942d-33cb0012cf0e", "Asset": { "AssetId": "6cf79f29-36ab-4e01-9bb2-7debb30eb8ab", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fc8ed7ef-80b8-4f35-9cfa-bd5d6d8180b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf844daa-4ba6-4e09-8ca9-4be46474313d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "191cd9e6-526c-4d64-9025-1deecf1c3749", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "MeasurementValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fe188081-08b7-4dde-a4ac-08f48eddf167", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "c4a01b68-d492-46b3-8646-54c8f8ea067b", "EffectiveDate": "2024-04-26T06:26:25.8466998-07:00", "StateType": { "StateTypeId": "39e82168-b07c-4826-8c6e-be35a7a37883", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "fc8ed7ef-80b8-4f35-9cfa-bd5d6d8180b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf844daa-4ba6-4e09-8ca9-4be46474313d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "45dfeb51-3837-49a7-af45-990a3b35bc3a", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c51d356e-ce80-4032-8b12-dd3cc3aa2c04", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "39b17cfe-79d6-4b52-b9ef-af117fab7de2", "EffectiveDate": "2024-04-26T06:26:25.8466998-07:00", "StatusType": { "StatusTypeId": "4c582f80-a549-48aa-b201-087b2d8c7f17", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "fc8ed7ef-80b8-4f35-9cfa-bd5d6d8180b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf844daa-4ba6-4e09-8ca9-4be46474313d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8579101c-003f-40a2-b857-42cbb76d3736", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a0bdbc96-47b6-4516-95fd-73396123b1a5", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "MeasurementValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "378adff4-9139-4a45-9235-5bb0cdacf7f9", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-26T06:26:25.8466998-07:00", "WellPurposeType": { "WellPurposeTypeId": "c9e1239f-df42-4e0c-9d3e-24fc1ffcd429", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f4c3d1dc-6547-458f-86da-794f34383faa", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0e4d8fb4-0cbb-477a-a83b-0b17b2b1561d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 4" }, { "WellPurposeId": "d9c69a3d-2d0f-45dc-942d-33cb0012cf0e", "Asset": { "AssetId": "6cf79f29-36ab-4e01-9bb2-7debb30eb8ab", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fc8ed7ef-80b8-4f35-9cfa-bd5d6d8180b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf844daa-4ba6-4e09-8ca9-4be46474313d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "191cd9e6-526c-4d64-9025-1deecf1c3749", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "MeasurementValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fe188081-08b7-4dde-a4ac-08f48eddf167", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "c4a01b68-d492-46b3-8646-54c8f8ea067b", "EffectiveDate": "2024-04-26T06:26:25.8466998-07:00", "StateType": { "StateTypeId": "39e82168-b07c-4826-8c6e-be35a7a37883", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "fc8ed7ef-80b8-4f35-9cfa-bd5d6d8180b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf844daa-4ba6-4e09-8ca9-4be46474313d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "45dfeb51-3837-49a7-af45-990a3b35bc3a", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c51d356e-ce80-4032-8b12-dd3cc3aa2c04", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "39b17cfe-79d6-4b52-b9ef-af117fab7de2", "EffectiveDate": "2024-04-26T06:26:25.8466998-07:00", "StatusType": { "StatusTypeId": "4c582f80-a549-48aa-b201-087b2d8c7f17", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "fc8ed7ef-80b8-4f35-9cfa-bd5d6d8180b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf844daa-4ba6-4e09-8ca9-4be46474313d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8579101c-003f-40a2-b857-42cbb76d3736", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a0bdbc96-47b6-4516-95fd-73396123b1a5", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "MeasurementValueNeededDate": "2024-04-26T06:26:25.8466998-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "378adff4-9139-4a45-9235-5bb0cdacf7f9", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-26T06:26:25.8466998-07:00", "WellPurposeType": { "WellPurposeTypeId": "c9e1239f-df42-4e0c-9d3e-24fc1ffcd429", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f4c3d1dc-6547-458f-86da-794f34383faa", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0e4d8fb4-0cbb-477a-a83b-0b17b2b1561d", "CreateDate": "2024-04-26T06:26:25.8466998-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T06:26:25.8466998-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }