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": "f1f07574-2f97-4bdd-accd-033d8cbc9bbd",
"Asset": {
"AssetId": "48f60ece-cf40-4605-a2ec-e89fbce00986",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7b14de5c-47d3-4044-b4b5-bb7883d82e0e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "472b894e-0531-4af4-9683-72f00373bea6",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b4ce6256-5e9b-4c93-ab62-5512cbc1a38e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"MeasurementValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f307f4c0-b7bd-45c5-94dc-b00d9b69a68f",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dd63a893-b16e-4476-8576-bd280e0e7f1b",
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"StateType": {
"StateTypeId": "9fb548c9-a506-41c1-94e0-3bca7d1e41b8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7b14de5c-47d3-4044-b4b5-bb7883d82e0e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "472b894e-0531-4af4-9683-72f00373bea6",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f49b6f73-cad2-4d28-b8df-8e1f1c3aeb91",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "28bbe02e-539e-4ea9-9dfe-b2014d140394",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "858d1ee3-bc4a-4e21-9a0f-2b1f43db98ff",
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"StatusType": {
"StatusTypeId": "91a24f68-0359-4932-af56-d3f35238899c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7b14de5c-47d3-4044-b4b5-bb7883d82e0e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "472b894e-0531-4af4-9683-72f00373bea6",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c81dc19b-4613-46e4-b0d6-787524210a11",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e7b87333-5bf6-4ad8-961d-136419f0f6aa",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9634a905-eada-4b2d-b951-dfd7f69977db",
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1850a818-dc93-4ea9-bafa-e3be63943883",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "896fd9fa-f207-4958-8384-6d006bb13111",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ced5dc0f-977b-4d4d-a97b-a371c3c16562",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"MeasurementValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "20528aec-a1a0-4752-9352-2d8975767bd3",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8a25354a-ece7-47f3-8648-3580c6903ebb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4a929da0-df10-4c03-9320-e3dea58cb005",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a0a92285-a880-4102-8801-ebf05dd63c4e",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "f1f07574-2f97-4bdd-accd-033d8cbc9bbd",
"Asset": {
"AssetId": "48f60ece-cf40-4605-a2ec-e89fbce00986",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7b14de5c-47d3-4044-b4b5-bb7883d82e0e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "472b894e-0531-4af4-9683-72f00373bea6",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b4ce6256-5e9b-4c93-ab62-5512cbc1a38e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"MeasurementValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f307f4c0-b7bd-45c5-94dc-b00d9b69a68f",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dd63a893-b16e-4476-8576-bd280e0e7f1b",
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"StateType": {
"StateTypeId": "9fb548c9-a506-41c1-94e0-3bca7d1e41b8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7b14de5c-47d3-4044-b4b5-bb7883d82e0e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "472b894e-0531-4af4-9683-72f00373bea6",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f49b6f73-cad2-4d28-b8df-8e1f1c3aeb91",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "28bbe02e-539e-4ea9-9dfe-b2014d140394",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "858d1ee3-bc4a-4e21-9a0f-2b1f43db98ff",
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"StatusType": {
"StatusTypeId": "91a24f68-0359-4932-af56-d3f35238899c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7b14de5c-47d3-4044-b4b5-bb7883d82e0e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "472b894e-0531-4af4-9683-72f00373bea6",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c81dc19b-4613-46e4-b0d6-787524210a11",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e7b87333-5bf6-4ad8-961d-136419f0f6aa",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9634a905-eada-4b2d-b951-dfd7f69977db",
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1850a818-dc93-4ea9-bafa-e3be63943883",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "896fd9fa-f207-4958-8384-6d006bb13111",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ced5dc0f-977b-4d4d-a97b-a371c3c16562",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"MeasurementValueNeededDate": "2026-09-26T14:00:47.2826772-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "20528aec-a1a0-4752-9352-2d8975767bd3",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8a25354a-ece7-47f3-8648-3580c6903ebb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4a929da0-df10-4c03-9320-e3dea58cb005",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-26T14:00:47.2826772-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a0a92285-a880-4102-8801-ebf05dd63c4e",
"CreateDate": "2026-09-26T14:00:47.2826772-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T14:00:47.2826772-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}