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": "fcc307d3-2b64-4d26-9f09-1965a7c521be", "Asset": { "AssetId": "8fc47e7d-c6c7-4c77-8b47-cf84b979ecdd", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "121af8f3-fff4-40a6-86b8-bd2684e130ee", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d035f67d-7af0-4e71-bafe-edfd130df356", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0920806a-d7f2-4000-8da4-268b5dc4236b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "MeasurementValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "SourceSystemId": "sample string 3", "CompanyId": "735e30f9-4962-4fa3-a3eb-24c6b1b13454", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "fd631c1e-ee32-435f-b5aa-4cf7512220bd", "EffectiveDate": "2024-04-25T15:03:23.5846954-07:00", "StatusType": { "StatusTypeId": "5ed73335-2449-465e-9a25-bd0ca1351b94", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "121af8f3-fff4-40a6-86b8-bd2684e130ee", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d035f67d-7af0-4e71-bafe-edfd130df356", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "26ca26f5-c575-4b54-bc0d-b24878b6df52", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d103b37a-07a2-49d1-a095-9b01e189b085", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "ef64676b-9c2c-45dd-8c1e-3255593c90a9", "EffectiveDate": "2024-04-25T15:03:23.5846954-07:00", "WellPurposeType": { "WellPurposeTypeId": "c86c18a0-73e4-4480-9097-10243dff2843", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "246d1714-2f27-4e75-a33f-ce2244435a8e", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "38afd3df-f3c2-4051-a18d-98fe10147ae7", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "MeasurementValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "c13aee77-c9f9-4e18-a752-fda6315e96cf", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-25T15:03:23.5846954-07:00", "StateType": { "StateTypeId": "ff688962-0ad0-49ac-9e44-0e0f1b30fd54", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "121af8f3-fff4-40a6-86b8-bd2684e130ee", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d035f67d-7af0-4e71-bafe-edfd130df356", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "64c33db0-5b05-4b85-8898-026244f23191", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f351df9c-7dc1-406c-a119-78563af2533d", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 4" }, { "StateId": "fcc307d3-2b64-4d26-9f09-1965a7c521be", "Asset": { "AssetId": "8fc47e7d-c6c7-4c77-8b47-cf84b979ecdd", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "121af8f3-fff4-40a6-86b8-bd2684e130ee", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d035f67d-7af0-4e71-bafe-edfd130df356", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0920806a-d7f2-4000-8da4-268b5dc4236b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "MeasurementValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "SourceSystemId": "sample string 3", "CompanyId": "735e30f9-4962-4fa3-a3eb-24c6b1b13454", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "fd631c1e-ee32-435f-b5aa-4cf7512220bd", "EffectiveDate": "2024-04-25T15:03:23.5846954-07:00", "StatusType": { "StatusTypeId": "5ed73335-2449-465e-9a25-bd0ca1351b94", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "121af8f3-fff4-40a6-86b8-bd2684e130ee", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d035f67d-7af0-4e71-bafe-edfd130df356", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "26ca26f5-c575-4b54-bc0d-b24878b6df52", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d103b37a-07a2-49d1-a095-9b01e189b085", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "ef64676b-9c2c-45dd-8c1e-3255593c90a9", "EffectiveDate": "2024-04-25T15:03:23.5846954-07:00", "WellPurposeType": { "WellPurposeTypeId": "c86c18a0-73e4-4480-9097-10243dff2843", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "246d1714-2f27-4e75-a33f-ce2244435a8e", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "38afd3df-f3c2-4051-a18d-98fe10147ae7", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "MeasurementValueNeededDate": "2024-04-25T15:03:23.5846954-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "c13aee77-c9f9-4e18-a752-fda6315e96cf", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-25T15:03:23.5846954-07:00", "StateType": { "StateTypeId": "ff688962-0ad0-49ac-9e44-0e0f1b30fd54", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "121af8f3-fff4-40a6-86b8-bd2684e130ee", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d035f67d-7af0-4e71-bafe-edfd130df356", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "64c33db0-5b05-4b85-8898-026244f23191", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f351df9c-7dc1-406c-a119-78563af2533d", "CreateDate": "2024-04-25T15:03:23.5846954-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-25T15:03:23.5846954-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }