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": "73c5ccfc-e55f-4be9-aba8-3194225e4e7a",
"Asset": {
"AssetId": "79d224db-e98e-48f2-87c9-a6107a22fc04",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7a0547c8-9aed-4631-98b3-18cdf5f0f36f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f064c1a-9b08-4b8f-bf77-ac3e807ab74e",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2cf468a1-3630-4335-9116-1e7c4f1bd430",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "14d268f7-8e95-4425-96a2-6636c3f4bc54",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "23f6be90-9133-4ab4-9f43-2376cda1b41e",
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"StateType": {
"StateTypeId": "dc8f53b7-b523-4613-9cc0-bb938b0fbf4c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7a0547c8-9aed-4631-98b3-18cdf5f0f36f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f064c1a-9b08-4b8f-bf77-ac3e807ab74e",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fa7e3141-0c6c-4626-9f82-09dafd5824ac",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52158afb-8524-4532-aed8-54232690ce36",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cc69a9a2-b57b-4163-8af7-adacb23ddd45",
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"StatusType": {
"StatusTypeId": "2c171f15-646f-4285-bac1-dc2e6e27202c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7a0547c8-9aed-4631-98b3-18cdf5f0f36f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f064c1a-9b08-4b8f-bf77-ac3e807ab74e",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cfc9babc-4ee5-470a-8a19-ad65a484bcdd",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "41e4903b-ba60-4fa8-97d7-4a36b0a0030f",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c52f8780-f24e-4939-b1a9-edb369aa2167",
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fb9ce552-54db-4651-bb31-b4d63f7a3a02",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dc525bbf-5b42-45f0-a277-e3e0326621b0",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce83bab9-79d8-407a-8372-bd3f6c690df6",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "63671f90-52d7-4d17-9644-b5a5797f097a",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ce35b1df-ba8d-4603-8e26-511f6e80d1aa",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7bc9a396-c375-43bc-a326-928d9850edb1",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c4cd9e1-8c40-426e-afc8-67420fdf6939",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "73c5ccfc-e55f-4be9-aba8-3194225e4e7a",
"Asset": {
"AssetId": "79d224db-e98e-48f2-87c9-a6107a22fc04",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7a0547c8-9aed-4631-98b3-18cdf5f0f36f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f064c1a-9b08-4b8f-bf77-ac3e807ab74e",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2cf468a1-3630-4335-9116-1e7c4f1bd430",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "14d268f7-8e95-4425-96a2-6636c3f4bc54",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "23f6be90-9133-4ab4-9f43-2376cda1b41e",
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"StateType": {
"StateTypeId": "dc8f53b7-b523-4613-9cc0-bb938b0fbf4c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7a0547c8-9aed-4631-98b3-18cdf5f0f36f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f064c1a-9b08-4b8f-bf77-ac3e807ab74e",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fa7e3141-0c6c-4626-9f82-09dafd5824ac",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52158afb-8524-4532-aed8-54232690ce36",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cc69a9a2-b57b-4163-8af7-adacb23ddd45",
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"StatusType": {
"StatusTypeId": "2c171f15-646f-4285-bac1-dc2e6e27202c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7a0547c8-9aed-4631-98b3-18cdf5f0f36f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f064c1a-9b08-4b8f-bf77-ac3e807ab74e",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cfc9babc-4ee5-470a-8a19-ad65a484bcdd",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "41e4903b-ba60-4fa8-97d7-4a36b0a0030f",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c52f8780-f24e-4939-b1a9-edb369aa2167",
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fb9ce552-54db-4651-bb31-b4d63f7a3a02",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dc525bbf-5b42-45f0-a277-e3e0326621b0",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce83bab9-79d8-407a-8372-bd3f6c690df6",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:51:33.5812942-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "63671f90-52d7-4d17-9644-b5a5797f097a",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ce35b1df-ba8d-4603-8e26-511f6e80d1aa",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7bc9a396-c375-43bc-a326-928d9850edb1",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-22T01:51:33.5812942-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c4cd9e1-8c40-426e-afc8-67420fdf6939",
"CreateDate": "2026-06-22T01:51:33.5812942-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:51:33.5812942-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}