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": "fb05ccbc-a92b-4329-a1bc-44914768fe56", "Asset": { "AssetId": "d7b10468-f55e-4984-95a8-5062f0830024", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ac0c7849-9a4b-43ea-bed7-9d4767ca0e12", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf0566f5-b1cc-4c9a-bcbe-d667ea0aef01", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5aa23f95-a62d-4364-8163-777a942c7a05", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "MeasurementValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bccdb0c2-129c-4a41-8ef2-3686bf7a33f7", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "7434721b-b918-4d81-b6ba-bcca3056e1fd", "EffectiveDate": "2024-04-28T21:28:33.7666642-07:00", "StatusType": { "StatusTypeId": "aa587368-9367-46f4-897d-8c3ff7b43290", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ac0c7849-9a4b-43ea-bed7-9d4767ca0e12", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf0566f5-b1cc-4c9a-bcbe-d667ea0aef01", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "72e17fd7-6e3c-4b00-828f-ac114cfa4be0", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a0147a24-0df9-4e25-843e-43165f504efe", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "45ebd786-a5e5-4cb9-9ba4-ed8d16939eaf", "EffectiveDate": "2024-04-28T21:28:33.7666642-07:00", "WellPurposeType": { "WellPurposeTypeId": "cf4b2cd7-debc-4de1-96ce-6f80e1ebf35a", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3dbcfe8f-66da-4551-8922-6aabf4fc35b9", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ca5be692-9e3a-4dde-bfff-70c88f1915fe", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "MeasurementValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4fb37ac5-85b4-46bf-bb69-9ac3aa19d281", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T21:28:33.7666642-07:00", "StateType": { "StateTypeId": "3d5e26e4-4bfd-4555-ae03-aab18c6bb86e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ac0c7849-9a4b-43ea-bed7-9d4767ca0e12", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf0566f5-b1cc-4c9a-bcbe-d667ea0aef01", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "f21b3ef4-87f9-459a-8214-28c4bf9bb0a7", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "018ba21d-21f8-4480-8dde-07e8901500c2", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 4" }, { "StateId": "fb05ccbc-a92b-4329-a1bc-44914768fe56", "Asset": { "AssetId": "d7b10468-f55e-4984-95a8-5062f0830024", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ac0c7849-9a4b-43ea-bed7-9d4767ca0e12", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf0566f5-b1cc-4c9a-bcbe-d667ea0aef01", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5aa23f95-a62d-4364-8163-777a942c7a05", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "MeasurementValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bccdb0c2-129c-4a41-8ef2-3686bf7a33f7", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "7434721b-b918-4d81-b6ba-bcca3056e1fd", "EffectiveDate": "2024-04-28T21:28:33.7666642-07:00", "StatusType": { "StatusTypeId": "aa587368-9367-46f4-897d-8c3ff7b43290", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ac0c7849-9a4b-43ea-bed7-9d4767ca0e12", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf0566f5-b1cc-4c9a-bcbe-d667ea0aef01", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "72e17fd7-6e3c-4b00-828f-ac114cfa4be0", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a0147a24-0df9-4e25-843e-43165f504efe", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "45ebd786-a5e5-4cb9-9ba4-ed8d16939eaf", "EffectiveDate": "2024-04-28T21:28:33.7666642-07:00", "WellPurposeType": { "WellPurposeTypeId": "cf4b2cd7-debc-4de1-96ce-6f80e1ebf35a", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3dbcfe8f-66da-4551-8922-6aabf4fc35b9", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ca5be692-9e3a-4dde-bfff-70c88f1915fe", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "MeasurementValueNeededDate": "2024-04-28T21:28:33.7666642-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4fb37ac5-85b4-46bf-bb69-9ac3aa19d281", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T21:28:33.7666642-07:00", "StateType": { "StateTypeId": "3d5e26e4-4bfd-4555-ae03-aab18c6bb86e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ac0c7849-9a4b-43ea-bed7-9d4767ca0e12", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf0566f5-b1cc-4c9a-bcbe-d667ea0aef01", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "f21b3ef4-87f9-459a-8214-28c4bf9bb0a7", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "018ba21d-21f8-4480-8dde-07e8901500c2", "CreateDate": "2024-04-28T21:28:33.7666642-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:28:33.7666642-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }