GET Statuses/ByEffectiveDate?assetId={assetId}&statusTypeId={statusTypeId}&beginDate={beginDate}&endDate={endDate}
Retrieves statuses 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. |
| statusTypeId |
Id of the status type |
globally unique identifier |
None. |
| beginDate |
Beginning effective date of the statuses to retrieve |
date |
None. |
| endDate |
Ending effective date of the statuses to retrieve |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of statuses.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Status |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"StatusId": "0f3d6242-ca9a-4619-bd85-ddaee9dd34fc",
"Asset": {
"AssetId": "35c83037-8e9b-4af0-b847-d1c550c22644",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2f66e989-1f68-4c2a-8762-393c79b6a639",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6dd44557-89a2-4369-94b7-333cb0d8629f",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "edc9084f-c666-4763-bae3-cee48a921b92",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"MeasurementValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9f1c405d-332c-4687-8009-72ad2469b5d4",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8702ae56-0655-4af8-be3b-9687b86b725d",
"EffectiveDate": "2026-01-20T16:58:56.0723685-08:00",
"StateType": {
"StateTypeId": "2c4c7753-9b2f-4d53-b951-0745a6138437",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2f66e989-1f68-4c2a-8762-393c79b6a639",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6dd44557-89a2-4369-94b7-333cb0d8629f",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e62da4d-be4c-4cb8-8bc4-28f8a4a6e32e",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "db2b9c93-22af-4f99-abb0-8545e6362180",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "883abecb-12d0-493b-914e-a12225836a03",
"EffectiveDate": "2026-01-20T16:58:56.0723685-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "065e8bd8-06aa-4584-9264-6a0b5a8cdec2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fe4ead6a-9bed-4e97-8bb6-2564006e3243",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a66c05fb-7297-4504-809d-c258c61c3156",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"MeasurementValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8bb97263-bde7-414f-affe-d5f31fc34e0a",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-01-20T16:58:56.0723685-08:00",
"StatusType": {
"StatusTypeId": "8604b605-0f83-4fc0-966d-47488b5f508d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2f66e989-1f68-4c2a-8762-393c79b6a639",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6dd44557-89a2-4369-94b7-333cb0d8629f",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cd163477-cce8-4b7d-af33-9b46f853d4ee",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0170ba31-9f9b-4ea1-b664-6968653e1aa4",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 4"
},
{
"StatusId": "0f3d6242-ca9a-4619-bd85-ddaee9dd34fc",
"Asset": {
"AssetId": "35c83037-8e9b-4af0-b847-d1c550c22644",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2f66e989-1f68-4c2a-8762-393c79b6a639",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6dd44557-89a2-4369-94b7-333cb0d8629f",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "edc9084f-c666-4763-bae3-cee48a921b92",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"MeasurementValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9f1c405d-332c-4687-8009-72ad2469b5d4",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8702ae56-0655-4af8-be3b-9687b86b725d",
"EffectiveDate": "2026-01-20T16:58:56.0723685-08:00",
"StateType": {
"StateTypeId": "2c4c7753-9b2f-4d53-b951-0745a6138437",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2f66e989-1f68-4c2a-8762-393c79b6a639",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6dd44557-89a2-4369-94b7-333cb0d8629f",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e62da4d-be4c-4cb8-8bc4-28f8a4a6e32e",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "db2b9c93-22af-4f99-abb0-8545e6362180",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "883abecb-12d0-493b-914e-a12225836a03",
"EffectiveDate": "2026-01-20T16:58:56.0723685-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "065e8bd8-06aa-4584-9264-6a0b5a8cdec2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fe4ead6a-9bed-4e97-8bb6-2564006e3243",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a66c05fb-7297-4504-809d-c258c61c3156",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"MeasurementValueNeededDate": "2026-01-20T16:58:56.0723685-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8bb97263-bde7-414f-affe-d5f31fc34e0a",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-01-20T16:58:56.0723685-08:00",
"StatusType": {
"StatusTypeId": "8604b605-0f83-4fc0-966d-47488b5f508d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2f66e989-1f68-4c2a-8762-393c79b6a639",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6dd44557-89a2-4369-94b7-333cb0d8629f",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cd163477-cce8-4b7d-af33-9b46f853d4ee",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0170ba31-9f9b-4ea1-b664-6968653e1aa4",
"CreateDate": "2026-01-20T16:58:56.0723685-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-20T16:58:56.0723685-08:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}