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": "94eb9b7a-d67b-43bf-b632-ed9efb988919",
"Asset": {
"AssetId": "8e6a4ffe-cdd2-4632-b771-af850431110e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fc6bfbec-a88c-4ebc-b6d0-46a359158075",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2001ae0e-a289-4bf2-9804-640168327ca0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "75caf59c-e53f-408d-abda-e2d821b412bf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"MeasurementValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "28ccaa08-9eac-4c12-8487-32f278c0742e",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "042107d8-b0b5-4961-a950-3dd9e6a4f4af",
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"StateType": {
"StateTypeId": "7db83809-9d4e-42b0-9951-3632ba17e649",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fc6bfbec-a88c-4ebc-b6d0-46a359158075",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2001ae0e-a289-4bf2-9804-640168327ca0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "61efe9c5-67ac-4793-bbf2-421f557f35b0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "286d42f6-eae7-4a61-b29e-75866816854b",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "682aad26-b910-4e7e-a027-ac8457cf255c",
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"StatusType": {
"StatusTypeId": "8eec9da0-5881-447b-8172-fd2721e13c40",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fc6bfbec-a88c-4ebc-b6d0-46a359158075",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2001ae0e-a289-4bf2-9804-640168327ca0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4ec3200e-6ec0-464a-8f87-a330f7af485d",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a02d570f-4094-4f86-88a9-a7595fbe5b43",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6ab839e8-c68e-4928-9539-75dbd8319d8c",
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "3c8359d4-1238-4c44-b7d2-a047a09508ba",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d2c458f8-91ae-4370-9e9b-b47237181f52",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9553a1d3-6bfd-4015-b996-4b09edb4ca29",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"MeasurementValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dc472d3b-20c6-42ae-91e0-d6b253f19dd6",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "12814e58-b309-443a-906d-2485d478fca9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5f764cf-c21b-4984-89ff-18afe06047b4",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a9f1f7f5-7a41-4f5c-ac54-5469be11661a",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "94eb9b7a-d67b-43bf-b632-ed9efb988919",
"Asset": {
"AssetId": "8e6a4ffe-cdd2-4632-b771-af850431110e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fc6bfbec-a88c-4ebc-b6d0-46a359158075",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2001ae0e-a289-4bf2-9804-640168327ca0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "75caf59c-e53f-408d-abda-e2d821b412bf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"MeasurementValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "28ccaa08-9eac-4c12-8487-32f278c0742e",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "042107d8-b0b5-4961-a950-3dd9e6a4f4af",
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"StateType": {
"StateTypeId": "7db83809-9d4e-42b0-9951-3632ba17e649",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fc6bfbec-a88c-4ebc-b6d0-46a359158075",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2001ae0e-a289-4bf2-9804-640168327ca0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "61efe9c5-67ac-4793-bbf2-421f557f35b0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "286d42f6-eae7-4a61-b29e-75866816854b",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "682aad26-b910-4e7e-a027-ac8457cf255c",
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"StatusType": {
"StatusTypeId": "8eec9da0-5881-447b-8172-fd2721e13c40",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fc6bfbec-a88c-4ebc-b6d0-46a359158075",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2001ae0e-a289-4bf2-9804-640168327ca0",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4ec3200e-6ec0-464a-8f87-a330f7af485d",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a02d570f-4094-4f86-88a9-a7595fbe5b43",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6ab839e8-c68e-4928-9539-75dbd8319d8c",
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "3c8359d4-1238-4c44-b7d2-a047a09508ba",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d2c458f8-91ae-4370-9e9b-b47237181f52",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9553a1d3-6bfd-4015-b996-4b09edb4ca29",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"MeasurementValueNeededDate": "2025-12-14T08:02:17.703156-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dc472d3b-20c6-42ae-91e0-d6b253f19dd6",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "12814e58-b309-443a-906d-2485d478fca9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5f764cf-c21b-4984-89ff-18afe06047b4",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-14T08:02:17.703156-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a9f1f7f5-7a41-4f5c-ac54-5469be11661a",
"CreateDate": "2025-12-14T08:02:17.703156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T08:02:17.703156-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}