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": "a9cafb20-a0d6-49ed-bc08-4ebc38490684",
"Asset": {
"AssetId": "bd0655e0-ba87-4732-b8ed-6801d85c31cd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4a17648d-3b01-4391-9fd8-5372b7b1ea1f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7739f514-508c-467e-ae92-0389484f6b21",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0e7eb767-36e7-4d6f-a651-3696610e12fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7630cba8-63c3-414c-8a73-b6f5ce227aae",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "eb40b33a-85af-48c0-820c-d7fddecd3f5b",
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"StateType": {
"StateTypeId": "5b156be2-8833-4a18-aafc-45a0d3361765",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4a17648d-3b01-4391-9fd8-5372b7b1ea1f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7739f514-508c-467e-ae92-0389484f6b21",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8a3258e1-7cae-4d1d-a393-850bdd06d217",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f1202413-a32e-484d-96b0-a74ef957da72",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ab45dc12-1655-4571-9d60-f386c83c8316",
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"StatusType": {
"StatusTypeId": "20cedb88-71a6-47eb-9d43-6a4d614cd18e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4a17648d-3b01-4391-9fd8-5372b7b1ea1f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7739f514-508c-467e-ae92-0389484f6b21",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "03a9214d-08fd-488c-b74c-b7cece40cc2a",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "17fa150e-1c6b-4039-9425-3e21fe477114",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "94365cf3-0e92-4f95-8ae3-3ca521d61fb7",
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b61e3ccd-5bc4-45ee-ba2d-a5864a0cddfb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a41d4c5a-c50e-4a12-ac5c-c1e527514cc6",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46784d44-d23c-44b2-ac36-78995f8abfc4",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c3055d0e-1f27-4213-896f-45bd74d334d8",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c7c90f9b-7891-4d3d-998c-e83315d8a629",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0623b057-be0b-49e3-b516-6f940f281085",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8bbbe101-26d5-40aa-bcc0-7deb5fafc51c",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "a9cafb20-a0d6-49ed-bc08-4ebc38490684",
"Asset": {
"AssetId": "bd0655e0-ba87-4732-b8ed-6801d85c31cd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4a17648d-3b01-4391-9fd8-5372b7b1ea1f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7739f514-508c-467e-ae92-0389484f6b21",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0e7eb767-36e7-4d6f-a651-3696610e12fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7630cba8-63c3-414c-8a73-b6f5ce227aae",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "eb40b33a-85af-48c0-820c-d7fddecd3f5b",
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"StateType": {
"StateTypeId": "5b156be2-8833-4a18-aafc-45a0d3361765",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4a17648d-3b01-4391-9fd8-5372b7b1ea1f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7739f514-508c-467e-ae92-0389484f6b21",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8a3258e1-7cae-4d1d-a393-850bdd06d217",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f1202413-a32e-484d-96b0-a74ef957da72",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ab45dc12-1655-4571-9d60-f386c83c8316",
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"StatusType": {
"StatusTypeId": "20cedb88-71a6-47eb-9d43-6a4d614cd18e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4a17648d-3b01-4391-9fd8-5372b7b1ea1f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7739f514-508c-467e-ae92-0389484f6b21",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "03a9214d-08fd-488c-b74c-b7cece40cc2a",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "17fa150e-1c6b-4039-9425-3e21fe477114",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "94365cf3-0e92-4f95-8ae3-3ca521d61fb7",
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b61e3ccd-5bc4-45ee-ba2d-a5864a0cddfb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a41d4c5a-c50e-4a12-ac5c-c1e527514cc6",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46784d44-d23c-44b2-ac36-78995f8abfc4",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:04:12.374209-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c3055d0e-1f27-4213-896f-45bd74d334d8",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c7c90f9b-7891-4d3d-998c-e83315d8a629",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0623b057-be0b-49e3-b516-6f940f281085",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T18:04:12.374209-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8bbbe101-26d5-40aa-bcc0-7deb5fafc51c",
"CreateDate": "2026-03-15T18:04:12.374209-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:04:12.374209-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}