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": "4002ed4b-1a5b-47bd-85de-037f5506da82",
"Asset": {
"AssetId": "9a84487d-6345-4295-9588-9e4e3081b83e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2699170b-089e-4219-9e56-d2c60879e143",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d41eb5d-01e0-4fc9-b6b9-4014f2c475bc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2ec7c47c-2b68-4785-93fe-ff92a8b69a5c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:26:57.8955915-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:57.8955915-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "88c4dd7b-b853-47f2-8904-13f71d5922dc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ba07e03c-233f-469b-87f2-07743958f067",
"EffectiveDate": "2025-10-13T15:26:57.8955915-07:00",
"StateType": {
"StateTypeId": "8aadc4e7-c71a-4d2d-8594-8dd77b54eda6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2699170b-089e-4219-9e56-d2c60879e143",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d41eb5d-01e0-4fc9-b6b9-4014f2c475bc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b86a7efa-69ef-41dc-a32f-daed8c33a9c1",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f3a2713-870e-477d-b723-b5afe0679cd8",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5d27aa28-04c7-4b09-8eed-617d08bd550a",
"EffectiveDate": "2025-10-13T15:26:57.9112075-07:00",
"StatusType": {
"StatusTypeId": "fd360eee-761c-48f0-a03f-086b35137e35",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2699170b-089e-4219-9e56-d2c60879e143",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d41eb5d-01e0-4fc9-b6b9-4014f2c475bc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "afaa3889-e9c6-4628-a580-48e5fdbc0f08",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "645f252f-6da3-411d-b78a-218b320c7d5d",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1ccd1f41-68dd-453a-966e-855e3cc055c2",
"EffectiveDate": "2025-10-13T15:26:57.9112075-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d80cd89b-9fd0-46c3-9eb8-60974a855b02",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "821f9c01-ae91-4e66-ba02-20a8ff91002c",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e69b1208-beb6-46d6-bb92-a6cf5f9e9d47",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:26:57.9112075-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:57.9112075-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "313d8ef1-638b-448d-a81b-44164f17aaa1",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "15e1ce92-bab3-4b76-8234-e461e8710477",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "64496b38-d5f9-4983-8469-aa27710b4fcd",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T15:26:57.9112075-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3eeee595-3e30-4b41-ada1-3b7344e20212",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "4002ed4b-1a5b-47bd-85de-037f5506da82",
"Asset": {
"AssetId": "9a84487d-6345-4295-9588-9e4e3081b83e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2699170b-089e-4219-9e56-d2c60879e143",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d41eb5d-01e0-4fc9-b6b9-4014f2c475bc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2ec7c47c-2b68-4785-93fe-ff92a8b69a5c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:26:57.8955915-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:57.8955915-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "88c4dd7b-b853-47f2-8904-13f71d5922dc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ba07e03c-233f-469b-87f2-07743958f067",
"EffectiveDate": "2025-10-13T15:26:57.8955915-07:00",
"StateType": {
"StateTypeId": "8aadc4e7-c71a-4d2d-8594-8dd77b54eda6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2699170b-089e-4219-9e56-d2c60879e143",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d41eb5d-01e0-4fc9-b6b9-4014f2c475bc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b86a7efa-69ef-41dc-a32f-daed8c33a9c1",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f3a2713-870e-477d-b723-b5afe0679cd8",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5d27aa28-04c7-4b09-8eed-617d08bd550a",
"EffectiveDate": "2025-10-13T15:26:57.9112075-07:00",
"StatusType": {
"StatusTypeId": "fd360eee-761c-48f0-a03f-086b35137e35",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2699170b-089e-4219-9e56-d2c60879e143",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d41eb5d-01e0-4fc9-b6b9-4014f2c475bc",
"CreateDate": "2025-10-13T15:26:57.8955915-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.8955915-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "afaa3889-e9c6-4628-a580-48e5fdbc0f08",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "645f252f-6da3-411d-b78a-218b320c7d5d",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1ccd1f41-68dd-453a-966e-855e3cc055c2",
"EffectiveDate": "2025-10-13T15:26:57.9112075-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d80cd89b-9fd0-46c3-9eb8-60974a855b02",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "821f9c01-ae91-4e66-ba02-20a8ff91002c",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e69b1208-beb6-46d6-bb92-a6cf5f9e9d47",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:26:57.9112075-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:57.9112075-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "313d8ef1-638b-448d-a81b-44164f17aaa1",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "15e1ce92-bab3-4b76-8234-e461e8710477",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "64496b38-d5f9-4983-8469-aa27710b4fcd",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T15:26:57.9112075-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3eeee595-3e30-4b41-ada1-3b7344e20212",
"CreateDate": "2025-10-13T15:26:57.9112075-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:57.9112075-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}