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": "abc690d7-17f9-4895-9594-3ca16ce2df18",
"Asset": {
"AssetId": "c2b75d45-43ee-43ad-a290-9f516f3e797d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "44174319-31d6-4120-849f-438ad5f7b422",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5efe88a7-7656-47ad-b86d-2ef0964eb4fa",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "57ba5759-e6a0-4ae9-a2e1-032930de93e7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "491139b2-e5a7-4299-9998-b0b01681a7ef",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "025608c3-d88f-4810-bf5d-950dbba1ee08",
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"StateType": {
"StateTypeId": "14bb948c-0c81-45b7-9896-a8603e68628d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "44174319-31d6-4120-849f-438ad5f7b422",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5efe88a7-7656-47ad-b86d-2ef0964eb4fa",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c3e06809-10e7-40ed-8410-e07046e232c4",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a921acb9-ef2a-4195-96b5-54a7416ae5fc",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9b40946c-4a19-4864-95a1-5f3ecaf3a27a",
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"StatusType": {
"StatusTypeId": "3a81b5bd-3777-4b00-885d-41286b4ffcd7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "44174319-31d6-4120-849f-438ad5f7b422",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5efe88a7-7656-47ad-b86d-2ef0964eb4fa",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "39449dc0-48cf-4ed0-9a88-405231d68151",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "26935ecd-cd98-4d34-bc5d-97aaca9baf23",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0ca08bfd-1d1c-4bd8-923c-2db01c899ce9",
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "bb70c08c-0b9d-492b-973d-cfd1a39040be",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "091fc639-5228-41e1-8dae-9abdf698b1a3",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46fc6f45-d65a-4dad-b057-4d74dcb18a49",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "24290c2f-402c-4715-98a2-fdd165e0e25a",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "438ac32c-a97c-4467-8ac3-4b68e924cd71",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c099f168-0b41-4a22-b010-13d19402037e",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "890cc9c7-3885-4f99-947b-ff1c7a142155",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "abc690d7-17f9-4895-9594-3ca16ce2df18",
"Asset": {
"AssetId": "c2b75d45-43ee-43ad-a290-9f516f3e797d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "44174319-31d6-4120-849f-438ad5f7b422",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5efe88a7-7656-47ad-b86d-2ef0964eb4fa",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "57ba5759-e6a0-4ae9-a2e1-032930de93e7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "491139b2-e5a7-4299-9998-b0b01681a7ef",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "025608c3-d88f-4810-bf5d-950dbba1ee08",
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"StateType": {
"StateTypeId": "14bb948c-0c81-45b7-9896-a8603e68628d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "44174319-31d6-4120-849f-438ad5f7b422",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5efe88a7-7656-47ad-b86d-2ef0964eb4fa",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c3e06809-10e7-40ed-8410-e07046e232c4",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a921acb9-ef2a-4195-96b5-54a7416ae5fc",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9b40946c-4a19-4864-95a1-5f3ecaf3a27a",
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"StatusType": {
"StatusTypeId": "3a81b5bd-3777-4b00-885d-41286b4ffcd7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "44174319-31d6-4120-849f-438ad5f7b422",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5efe88a7-7656-47ad-b86d-2ef0964eb4fa",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "39449dc0-48cf-4ed0-9a88-405231d68151",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "26935ecd-cd98-4d34-bc5d-97aaca9baf23",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0ca08bfd-1d1c-4bd8-923c-2db01c899ce9",
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "bb70c08c-0b9d-492b-973d-cfd1a39040be",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "091fc639-5228-41e1-8dae-9abdf698b1a3",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46fc6f45-d65a-4dad-b057-4d74dcb18a49",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:56:53.6513606-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "24290c2f-402c-4715-98a2-fdd165e0e25a",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "438ac32c-a97c-4467-8ac3-4b68e924cd71",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c099f168-0b41-4a22-b010-13d19402037e",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-04T16:56:53.6513606-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "890cc9c7-3885-4f99-947b-ff1c7a142155",
"CreateDate": "2025-11-04T16:56:53.6513606-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:56:53.6513606-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}