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": "bdaad538-117d-422e-96c6-f074ae4a2b28",
"Asset": {
"AssetId": "f556c279-43c2-42f5-b08e-45b4023a0ecb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f957175d-71ee-47db-8685-486d65e4335f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ee472c33-b0c0-49cc-915d-19a9bf4f5b0d",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f1ee4321-dc0f-4ae2-bada-298abab5f212",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"MeasurementValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f66b5afa-90b6-4491-943d-4fbcd394db51",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "06cf0b56-9e79-4806-8adc-d3b534e62189",
"EffectiveDate": "2026-06-13T10:54:56.0161968-07:00",
"StatusType": {
"StatusTypeId": "a6958f12-4255-44bf-aa7e-eaec4a7cc881",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f957175d-71ee-47db-8685-486d65e4335f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ee472c33-b0c0-49cc-915d-19a9bf4f5b0d",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7a28f2dc-6497-4407-8cb7-e9fb7df1df28",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a62f832e-d990-42b1-9739-ac285bba7a80",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2d1bf12d-a62a-4493-9af7-22d227b6cd30",
"EffectiveDate": "2026-06-13T10:54:56.0161968-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b056efc4-a9a6-4396-b018-06862861b066",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c62dc1b6-e38a-472a-a656-84f9b396d468",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4758790a-f144-442c-aeb2-593d13fcf104",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"MeasurementValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4f3b073c-68f6-45c7-b7f9-50aa7ea96ae1",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-13T10:54:56.0161968-07:00",
"StateType": {
"StateTypeId": "85223af4-879f-46f8-a632-f8ad611e0537",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f957175d-71ee-47db-8685-486d65e4335f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ee472c33-b0c0-49cc-915d-19a9bf4f5b0d",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e085042-6473-4288-a334-31f3763d21f7",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "732dff8e-7602-46e8-8356-2002d188a5e0",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 4"
},
{
"StateId": "bdaad538-117d-422e-96c6-f074ae4a2b28",
"Asset": {
"AssetId": "f556c279-43c2-42f5-b08e-45b4023a0ecb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f957175d-71ee-47db-8685-486d65e4335f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ee472c33-b0c0-49cc-915d-19a9bf4f5b0d",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f1ee4321-dc0f-4ae2-bada-298abab5f212",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"MeasurementValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f66b5afa-90b6-4491-943d-4fbcd394db51",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "06cf0b56-9e79-4806-8adc-d3b534e62189",
"EffectiveDate": "2026-06-13T10:54:56.0161968-07:00",
"StatusType": {
"StatusTypeId": "a6958f12-4255-44bf-aa7e-eaec4a7cc881",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f957175d-71ee-47db-8685-486d65e4335f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ee472c33-b0c0-49cc-915d-19a9bf4f5b0d",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7a28f2dc-6497-4407-8cb7-e9fb7df1df28",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a62f832e-d990-42b1-9739-ac285bba7a80",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2d1bf12d-a62a-4493-9af7-22d227b6cd30",
"EffectiveDate": "2026-06-13T10:54:56.0161968-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b056efc4-a9a6-4396-b018-06862861b066",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c62dc1b6-e38a-472a-a656-84f9b396d468",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4758790a-f144-442c-aeb2-593d13fcf104",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"MeasurementValueNeededDate": "2026-06-13T10:54:56.0161968-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4f3b073c-68f6-45c7-b7f9-50aa7ea96ae1",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-13T10:54:56.0161968-07:00",
"StateType": {
"StateTypeId": "85223af4-879f-46f8-a632-f8ad611e0537",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f957175d-71ee-47db-8685-486d65e4335f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ee472c33-b0c0-49cc-915d-19a9bf4f5b0d",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e085042-6473-4288-a334-31f3763d21f7",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "732dff8e-7602-46e8-8356-2002d188a5e0",
"CreateDate": "2026-06-13T10:54:56.0161968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T10:54:56.0161968-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}