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": "28f026b6-d368-49d3-a5a8-6de86a39dc95",
"Asset": {
"AssetId": "586d9ea6-1685-452e-9b1d-6fec58126341",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0ca5ff88-a5f2-4566-ac80-fd61fbad44b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8a1dd74b-5a7e-4356-99ce-d3db3c30c31f",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5de2002c-aa95-4eab-b6b1-0ba82ab898b2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a5d4da47-a894-42de-a45b-41637c76a85d",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "30a0a766-14e4-405b-a56c-8619c4170bf0",
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"StateType": {
"StateTypeId": "736b19c8-0aa8-481c-84b1-204ddfc7bd52",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0ca5ff88-a5f2-4566-ac80-fd61fbad44b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8a1dd74b-5a7e-4356-99ce-d3db3c30c31f",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b0e8feb6-c4bf-4708-9076-0409908b4184",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "da230ad7-feba-4506-906c-7156d4f7ff93",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8db245dd-b0d0-4658-b326-77e6d9bc4ad2",
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"StatusType": {
"StatusTypeId": "40cbbaac-56aa-462b-9bbb-71d91efeeb42",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0ca5ff88-a5f2-4566-ac80-fd61fbad44b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8a1dd74b-5a7e-4356-99ce-d3db3c30c31f",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b5305a68-de0b-4bd3-b689-0657bede24ce",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b927f80c-81fc-4946-96df-a3241be21af2",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "30fc2277-dee4-4bcd-ad73-0450543c9119",
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "74c4712c-6509-4bb8-981f-d8a48519a66a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5be01352-28c1-4a91-891c-e5a935fd1da6",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4eeae7aa-29eb-499a-baad-f054604b6a3b",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af16d874-91aa-4af0-ac54-f93576e3a6f5",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7632289c-5722-4ab6-a250-7b67c9a19e87",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5e3218d1-b03f-4eb1-830f-48f29ad68b51",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3b480cd0-269b-48d0-af7b-7f6635bd0bfe",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "28f026b6-d368-49d3-a5a8-6de86a39dc95",
"Asset": {
"AssetId": "586d9ea6-1685-452e-9b1d-6fec58126341",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0ca5ff88-a5f2-4566-ac80-fd61fbad44b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8a1dd74b-5a7e-4356-99ce-d3db3c30c31f",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5de2002c-aa95-4eab-b6b1-0ba82ab898b2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a5d4da47-a894-42de-a45b-41637c76a85d",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "30a0a766-14e4-405b-a56c-8619c4170bf0",
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"StateType": {
"StateTypeId": "736b19c8-0aa8-481c-84b1-204ddfc7bd52",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0ca5ff88-a5f2-4566-ac80-fd61fbad44b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8a1dd74b-5a7e-4356-99ce-d3db3c30c31f",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b0e8feb6-c4bf-4708-9076-0409908b4184",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "da230ad7-feba-4506-906c-7156d4f7ff93",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8db245dd-b0d0-4658-b326-77e6d9bc4ad2",
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"StatusType": {
"StatusTypeId": "40cbbaac-56aa-462b-9bbb-71d91efeeb42",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0ca5ff88-a5f2-4566-ac80-fd61fbad44b9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8a1dd74b-5a7e-4356-99ce-d3db3c30c31f",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b5305a68-de0b-4bd3-b689-0657bede24ce",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b927f80c-81fc-4946-96df-a3241be21af2",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "30fc2277-dee4-4bcd-ad73-0450543c9119",
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "74c4712c-6509-4bb8-981f-d8a48519a66a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5be01352-28c1-4a91-891c-e5a935fd1da6",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4eeae7aa-29eb-499a-baad-f054604b6a3b",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:28:26.0924339-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af16d874-91aa-4af0-ac54-f93576e3a6f5",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7632289c-5722-4ab6-a250-7b67c9a19e87",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5e3218d1-b03f-4eb1-830f-48f29ad68b51",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-11T22:28:26.0924339-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3b480cd0-269b-48d0-af7b-7f6635bd0bfe",
"CreateDate": "2026-08-11T22:28:26.0924339-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:28:26.0924339-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}