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": "0c2a90c0-38f6-43de-9269-2fab3bdd6007",
"Asset": {
"AssetId": "b11d78f7-df02-456c-8801-a88318b40263",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bf1dcebc-756e-473c-9c70-e903801ab4e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25059d37-801b-4510-ba57-8c21e4364358",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4a782a16-1b56-423b-aba3-5fe76fa3b60e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"MeasurementValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7eeb3c98-7bf7-43a3-9a88-24e95e4c2dac",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fbc4caf8-0f1e-4756-bc35-3d72bce147dc",
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"StateType": {
"StateTypeId": "1e565fef-1875-486c-a6f6-be74e7335a8c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bf1dcebc-756e-473c-9c70-e903801ab4e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25059d37-801b-4510-ba57-8c21e4364358",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "52b877f4-7c7c-4007-8708-a19e8f0d8777",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "caf15388-e802-49ba-86e6-e0b55058bea8",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3fb87757-359b-4bdd-9925-2e4f2ae51f9f",
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"StatusType": {
"StatusTypeId": "22f0400b-d354-45fb-92bb-574b1e4f2f95",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bf1dcebc-756e-473c-9c70-e903801ab4e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25059d37-801b-4510-ba57-8c21e4364358",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6c87d73c-76fa-48fc-b210-08a43236521d",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "211278fd-c733-40b8-9086-552836643e9a",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "af7c2c30-952b-4994-86a6-57a2ff8652f6",
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "eebf91eb-7c5a-44fd-b061-12dff04c435f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9f36f804-9f8f-4e91-8cee-c89f3de71857",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b54f927d-3035-48c5-b25b-d2b38fa61df4",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"MeasurementValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cc59f774-ab82-46e6-ac3b-14cb54aefef1",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5cdb3fa0-cf3c-48c1-b5da-d1996d63f5ef",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "762c47d2-92ba-426f-9b88-1a55b1b36507",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "50bf8d12-7e9e-4bd1-b70d-e6f46ec0317b",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "0c2a90c0-38f6-43de-9269-2fab3bdd6007",
"Asset": {
"AssetId": "b11d78f7-df02-456c-8801-a88318b40263",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bf1dcebc-756e-473c-9c70-e903801ab4e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25059d37-801b-4510-ba57-8c21e4364358",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4a782a16-1b56-423b-aba3-5fe76fa3b60e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"MeasurementValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7eeb3c98-7bf7-43a3-9a88-24e95e4c2dac",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fbc4caf8-0f1e-4756-bc35-3d72bce147dc",
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"StateType": {
"StateTypeId": "1e565fef-1875-486c-a6f6-be74e7335a8c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bf1dcebc-756e-473c-9c70-e903801ab4e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25059d37-801b-4510-ba57-8c21e4364358",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "52b877f4-7c7c-4007-8708-a19e8f0d8777",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "caf15388-e802-49ba-86e6-e0b55058bea8",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3fb87757-359b-4bdd-9925-2e4f2ae51f9f",
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"StatusType": {
"StatusTypeId": "22f0400b-d354-45fb-92bb-574b1e4f2f95",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bf1dcebc-756e-473c-9c70-e903801ab4e7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25059d37-801b-4510-ba57-8c21e4364358",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6c87d73c-76fa-48fc-b210-08a43236521d",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "211278fd-c733-40b8-9086-552836643e9a",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "af7c2c30-952b-4994-86a6-57a2ff8652f6",
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "eebf91eb-7c5a-44fd-b061-12dff04c435f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9f36f804-9f8f-4e91-8cee-c89f3de71857",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b54f927d-3035-48c5-b25b-d2b38fa61df4",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"MeasurementValueNeededDate": "2026-02-02T13:50:54.8073453-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cc59f774-ab82-46e6-ac3b-14cb54aefef1",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5cdb3fa0-cf3c-48c1-b5da-d1996d63f5ef",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "762c47d2-92ba-426f-9b88-1a55b1b36507",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T13:50:54.8073453-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "50bf8d12-7e9e-4bd1-b70d-e6f46ec0317b",
"CreateDate": "2026-02-02T13:50:54.8073453-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T13:50:54.8073453-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}