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": "9b434c2d-685a-4b06-8657-57c25002a078",
"Asset": {
"AssetId": "3a4369b9-0ff0-440f-9935-6014b0973e21",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "32868332-e060-4e6f-8e58-4aca521ee63a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fecbbfff-8515-4e4e-9c29-f8beea6e4eee",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ac415ffb-f792-438d-8edf-32c3c754b774",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e0b4c61b-f79e-4ad0-8b02-4de23c0bb4b6",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "36eda6a1-0ed7-4c2f-9811-66780c48415c",
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"StateType": {
"StateTypeId": "3a0f3b82-80c4-44dd-a8c8-b8b6a7736807",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "32868332-e060-4e6f-8e58-4aca521ee63a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fecbbfff-8515-4e4e-9c29-f8beea6e4eee",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2ae6d4e0-eb73-4e12-a349-62f1aafdb9dc",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "03699d09-7104-47cd-8e19-8cde58d18b4c",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "441690b7-56a2-4377-94e0-1cd1b32cfd40",
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"StatusType": {
"StatusTypeId": "e70fad17-22ce-4f0a-873a-074f8ee53b74",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "32868332-e060-4e6f-8e58-4aca521ee63a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fecbbfff-8515-4e4e-9c29-f8beea6e4eee",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "780d12d1-d251-413b-ba78-79c58363905c",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6c0f2ad7-d2ac-461d-9797-c9d62afbc36e",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "714fd359-073c-4c2c-9295-a83aaf8cc84b",
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f74d97b6-71bc-4d93-8820-4bae8e13a94c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "59562c31-0115-4272-a875-bf58a9db45b8",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5c04461e-0e97-44d1-bc5d-70682098d16b",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6ba11907-c3f5-4ca4-980d-8e41317b0a68",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b7849865-5ae1-450b-975f-3d7a6aabe412",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f7755382-301f-45f5-a530-2650903271d9",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "399b7dc3-57bc-4bdb-9a71-a0ed1a74fd3d",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "9b434c2d-685a-4b06-8657-57c25002a078",
"Asset": {
"AssetId": "3a4369b9-0ff0-440f-9935-6014b0973e21",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "32868332-e060-4e6f-8e58-4aca521ee63a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fecbbfff-8515-4e4e-9c29-f8beea6e4eee",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ac415ffb-f792-438d-8edf-32c3c754b774",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e0b4c61b-f79e-4ad0-8b02-4de23c0bb4b6",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "36eda6a1-0ed7-4c2f-9811-66780c48415c",
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"StateType": {
"StateTypeId": "3a0f3b82-80c4-44dd-a8c8-b8b6a7736807",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "32868332-e060-4e6f-8e58-4aca521ee63a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fecbbfff-8515-4e4e-9c29-f8beea6e4eee",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2ae6d4e0-eb73-4e12-a349-62f1aafdb9dc",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "03699d09-7104-47cd-8e19-8cde58d18b4c",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "441690b7-56a2-4377-94e0-1cd1b32cfd40",
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"StatusType": {
"StatusTypeId": "e70fad17-22ce-4f0a-873a-074f8ee53b74",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "32868332-e060-4e6f-8e58-4aca521ee63a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fecbbfff-8515-4e4e-9c29-f8beea6e4eee",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "780d12d1-d251-413b-ba78-79c58363905c",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6c0f2ad7-d2ac-461d-9797-c9d62afbc36e",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "714fd359-073c-4c2c-9295-a83aaf8cc84b",
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f74d97b6-71bc-4d93-8820-4bae8e13a94c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "59562c31-0115-4272-a875-bf58a9db45b8",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5c04461e-0e97-44d1-bc5d-70682098d16b",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:34:42.8318536-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6ba11907-c3f5-4ca4-980d-8e41317b0a68",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b7849865-5ae1-450b-975f-3d7a6aabe412",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f7755382-301f-45f5-a530-2650903271d9",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-18T23:34:42.8318536-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "399b7dc3-57bc-4bdb-9a71-a0ed1a74fd3d",
"CreateDate": "2025-07-18T23:34:42.8318536-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:34:42.8318536-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}