GET States/ByEffectiveDate?assetId={assetId}&stateTypeId={stateTypeId}&beginDate={beginDate}&endDate={endDate}
Retrieves states 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. |
stateTypeId |
Id of the state type |
globally unique identifier |
None. |
beginDate |
Beginning effective date of the states to retrieve |
date |
None. |
endDate |
Ending effective date of the states to retrieve |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of states.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of State |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "StateId": "4be27045-78eb-455d-a034-e9f1383160f1", "Asset": { "AssetId": "35da8fa7-ec64-4a51-b68b-3f36ca52da1a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a297959e-4ca6-45e9-a9bf-bc5ce39dcf22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2a24b5bc-424d-4b44-ba78-11b898d623c4", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "d7b235b2-462a-4dc4-a407-5b73808231e4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "MeasurementValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "SourceSystemId": "sample string 3", "CompanyId": "34c9da67-6ba5-4737-8bc9-6260f2cee542", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "c52baa89-3dee-47ac-8142-906f805d3d8a", "EffectiveDate": "2025-07-19T03:16:15.8753857-07:00", "StatusType": { "StatusTypeId": "222b8ac6-8fab-4d68-8128-c901e5eb8ae4", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a297959e-4ca6-45e9-a9bf-bc5ce39dcf22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2a24b5bc-424d-4b44-ba78-11b898d623c4", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "be2fab8f-8e35-42a8-9aea-d84c61acdcc7", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "558c0bfa-1b54-4a02-a3c5-fed9b8f8b6cf", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "2e7aa6b3-97e9-4928-bf81-52f6a3429022", "EffectiveDate": "2025-07-19T03:16:15.8753857-07:00", "WellPurposeType": { "WellPurposeTypeId": "bea1772c-52bf-4608-8c80-03f9ff9e3527", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "adbf880e-2b3f-461d-a94b-c37d8f7b266f", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "dc51d79c-82a3-4a7e-91ca-3286ff9852a5", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "MeasurementValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "82dfbf41-192b-49b4-9a0c-c6f4a2cb139f", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T03:16:15.8753857-07:00", "StateType": { "StateTypeId": "4951a863-9dda-479b-8523-f69ebcaf9aba", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a297959e-4ca6-45e9-a9bf-bc5ce39dcf22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2a24b5bc-424d-4b44-ba78-11b898d623c4", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ef909068-e91b-4448-8ad4-8a1fc6735a01", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "27d95ce7-2a76-43ea-b3a0-064f6d17da4b", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 4" }, { "StateId": "4be27045-78eb-455d-a034-e9f1383160f1", "Asset": { "AssetId": "35da8fa7-ec64-4a51-b68b-3f36ca52da1a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a297959e-4ca6-45e9-a9bf-bc5ce39dcf22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2a24b5bc-424d-4b44-ba78-11b898d623c4", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "d7b235b2-462a-4dc4-a407-5b73808231e4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "MeasurementValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "SourceSystemId": "sample string 3", "CompanyId": "34c9da67-6ba5-4737-8bc9-6260f2cee542", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "c52baa89-3dee-47ac-8142-906f805d3d8a", "EffectiveDate": "2025-07-19T03:16:15.8753857-07:00", "StatusType": { "StatusTypeId": "222b8ac6-8fab-4d68-8128-c901e5eb8ae4", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a297959e-4ca6-45e9-a9bf-bc5ce39dcf22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2a24b5bc-424d-4b44-ba78-11b898d623c4", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "be2fab8f-8e35-42a8-9aea-d84c61acdcc7", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "558c0bfa-1b54-4a02-a3c5-fed9b8f8b6cf", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "2e7aa6b3-97e9-4928-bf81-52f6a3429022", "EffectiveDate": "2025-07-19T03:16:15.8753857-07:00", "WellPurposeType": { "WellPurposeTypeId": "bea1772c-52bf-4608-8c80-03f9ff9e3527", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "adbf880e-2b3f-461d-a94b-c37d8f7b266f", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "dc51d79c-82a3-4a7e-91ca-3286ff9852a5", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "MeasurementValueNeededDate": "2025-07-19T03:16:15.8753857-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "82dfbf41-192b-49b4-9a0c-c6f4a2cb139f", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T03:16:15.8753857-07:00", "StateType": { "StateTypeId": "4951a863-9dda-479b-8523-f69ebcaf9aba", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a297959e-4ca6-45e9-a9bf-bc5ce39dcf22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2a24b5bc-424d-4b44-ba78-11b898d623c4", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ef909068-e91b-4448-8ad4-8a1fc6735a01", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "27d95ce7-2a76-43ea-b3a0-064f6d17da4b", "CreateDate": "2025-07-19T03:16:15.8753857-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T03:16:15.8753857-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }