GET Notes/ByEffectiveDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}
Retrieves notes 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. |
| beginDate |
Beginning effective date of the notes to retrieve |
date |
None. |
| endDate |
Ending effective date of the notes to retrieve |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"NoteId": "03ada157-0250-4a81-b7fa-593f5a80299f",
"Asset": {
"AssetId": "febee189-fa50-41cb-9afe-cab508b2c0fc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1bb16da6-544b-452c-89a4-0b92b63e9e16",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a45bd43d-8e67-4035-a00d-64d0a5ed3bfe",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0d749390-67e1-488c-82d0-83aa60adca29",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2a881911-a43f-46d2-9945-75669a2e1a1c",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2dbf19f3-be3b-4316-b7da-c3cee7baae35",
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"StateType": {
"StateTypeId": "4974b62a-4929-457c-ab4b-73d8e30790bf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1bb16da6-544b-452c-89a4-0b92b63e9e16",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a45bd43d-8e67-4035-a00d-64d0a5ed3bfe",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "28414609-3794-40c7-9230-e4eb81238cd0",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "30f8f217-6746-4b49-82b5-5313734bd80f",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9ef27fde-212a-43ee-a9bd-3ff42d8d40d3",
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"StatusType": {
"StatusTypeId": "ed56235b-6125-432d-ad13-7bf142d32ad1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1bb16da6-544b-452c-89a4-0b92b63e9e16",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a45bd43d-8e67-4035-a00d-64d0a5ed3bfe",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8ead7cb7-9498-477b-bd01-b0c6b967823a",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f9b69770-bd3b-4432-9d41-6da0588da9b8",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4f7064a4-c017-461c-946e-6f7ccfb9217e",
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b8f55ad0-e7b7-4d81-a10a-38988a87630b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2269308b-6f16-4d4d-bf66-78e16fbcf1ea",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "94a603f4-9391-41d5-878d-9f90f56399b5",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9558efac-f0f7-46b2-a7a1-1a3acbcefb83",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "febcf4bf-751a-48b0-9608-5ccd3f52f8c6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9dab8954-a159-483c-82e8-d3328a5332a7",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5eb1bd6f-0195-40c7-bcb7-6077c6a35c5a",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "03ada157-0250-4a81-b7fa-593f5a80299f",
"Asset": {
"AssetId": "febee189-fa50-41cb-9afe-cab508b2c0fc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1bb16da6-544b-452c-89a4-0b92b63e9e16",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a45bd43d-8e67-4035-a00d-64d0a5ed3bfe",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0d749390-67e1-488c-82d0-83aa60adca29",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2a881911-a43f-46d2-9945-75669a2e1a1c",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2dbf19f3-be3b-4316-b7da-c3cee7baae35",
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"StateType": {
"StateTypeId": "4974b62a-4929-457c-ab4b-73d8e30790bf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1bb16da6-544b-452c-89a4-0b92b63e9e16",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a45bd43d-8e67-4035-a00d-64d0a5ed3bfe",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "28414609-3794-40c7-9230-e4eb81238cd0",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "30f8f217-6746-4b49-82b5-5313734bd80f",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9ef27fde-212a-43ee-a9bd-3ff42d8d40d3",
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"StatusType": {
"StatusTypeId": "ed56235b-6125-432d-ad13-7bf142d32ad1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1bb16da6-544b-452c-89a4-0b92b63e9e16",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a45bd43d-8e67-4035-a00d-64d0a5ed3bfe",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8ead7cb7-9498-477b-bd01-b0c6b967823a",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f9b69770-bd3b-4432-9d41-6da0588da9b8",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4f7064a4-c017-461c-946e-6f7ccfb9217e",
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b8f55ad0-e7b7-4d81-a10a-38988a87630b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2269308b-6f16-4d4d-bf66-78e16fbcf1ea",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "94a603f4-9391-41d5-878d-9f90f56399b5",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:55:08.9407929-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9558efac-f0f7-46b2-a7a1-1a3acbcefb83",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "febcf4bf-751a-48b0-9608-5ccd3f52f8c6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9dab8954-a159-483c-82e8-d3328a5332a7",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-17T18:55:08.9407929-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5eb1bd6f-0195-40c7-bcb7-6077c6a35c5a",
"CreateDate": "2025-11-17T18:55:08.9407929-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:55:08.9407929-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}