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": "3dc6ccc4-6da7-400f-8c8d-e6a86460c8e2", "Asset": { "AssetId": "9c08ab76-1801-42ec-9cd9-92d5f2389f0f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1d6a7fe7-f14a-4b96-808b-9c1f3367ae83", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "395721d9-4ba3-43ac-8e2e-e5366549c112", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cf8614c4-57cb-45d4-bb62-7e95c443da4b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "MeasurementValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c720be55-cd0e-4ccd-a9f1-95d49b4258a0", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "273e1a94-4555-4b8c-bb85-0a5e03622fd8", "EffectiveDate": "2024-04-28T14:43:52.4538963-07:00", "StateType": { "StateTypeId": "5a67a64d-7c1b-46f7-bc94-eb26d149a5e7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "1d6a7fe7-f14a-4b96-808b-9c1f3367ae83", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "395721d9-4ba3-43ac-8e2e-e5366549c112", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e5dfc756-2747-4424-82df-e482c2cd4854", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "126512a8-2f7f-49cb-8fee-7b1c201f611f", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "35b2dbf9-3a3b-4ed0-a1d4-f96729dd5198", "EffectiveDate": "2024-04-28T14:43:52.4538963-07:00", "StatusType": { "StatusTypeId": "f28ff49c-c5d2-4d96-b414-bb31af055310", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "1d6a7fe7-f14a-4b96-808b-9c1f3367ae83", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "395721d9-4ba3-43ac-8e2e-e5366549c112", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "554d237d-75a9-4c39-8a02-7ec97ade4123", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d54f69a8-b9f0-4919-bd03-15394094c9b4", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "MeasurementValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "60e992fa-16a9-4f82-b18a-2707c11955f3", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T14:43:52.4538963-07:00", "WellPurposeType": { "WellPurposeTypeId": "9985fdee-b44b-43ae-add7-7d998c8a1768", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e36ef328-81b6-471d-8f91-8a878b62b545", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a2a51485-6f2a-45bc-b2e4-87ee59ef5c0f", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 4" }, { "WellPurposeId": "3dc6ccc4-6da7-400f-8c8d-e6a86460c8e2", "Asset": { "AssetId": "9c08ab76-1801-42ec-9cd9-92d5f2389f0f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1d6a7fe7-f14a-4b96-808b-9c1f3367ae83", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "395721d9-4ba3-43ac-8e2e-e5366549c112", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cf8614c4-57cb-45d4-bb62-7e95c443da4b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "MeasurementValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c720be55-cd0e-4ccd-a9f1-95d49b4258a0", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "273e1a94-4555-4b8c-bb85-0a5e03622fd8", "EffectiveDate": "2024-04-28T14:43:52.4538963-07:00", "StateType": { "StateTypeId": "5a67a64d-7c1b-46f7-bc94-eb26d149a5e7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "1d6a7fe7-f14a-4b96-808b-9c1f3367ae83", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "395721d9-4ba3-43ac-8e2e-e5366549c112", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e5dfc756-2747-4424-82df-e482c2cd4854", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "126512a8-2f7f-49cb-8fee-7b1c201f611f", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "35b2dbf9-3a3b-4ed0-a1d4-f96729dd5198", "EffectiveDate": "2024-04-28T14:43:52.4538963-07:00", "StatusType": { "StatusTypeId": "f28ff49c-c5d2-4d96-b414-bb31af055310", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "1d6a7fe7-f14a-4b96-808b-9c1f3367ae83", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "395721d9-4ba3-43ac-8e2e-e5366549c112", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "554d237d-75a9-4c39-8a02-7ec97ade4123", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d54f69a8-b9f0-4919-bd03-15394094c9b4", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "MeasurementValueNeededDate": "2024-04-28T14:43:52.4538963-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "60e992fa-16a9-4f82-b18a-2707c11955f3", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T14:43:52.4538963-07:00", "WellPurposeType": { "WellPurposeTypeId": "9985fdee-b44b-43ae-add7-7d998c8a1768", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e36ef328-81b6-471d-8f91-8a878b62b545", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a2a51485-6f2a-45bc-b2e4-87ee59ef5c0f", "CreateDate": "2024-04-28T14:43:52.4538963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T14:43:52.4538963-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }