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": "33c409f5-b814-4420-b33f-7708f0b2ba41",
"Asset": {
"AssetId": "d904c466-b7ea-42b1-9559-0f1b22ee6d74",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2bb47932-04cc-4832-b6b2-a3003d0a6089",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "087c73cd-1170-4030-b321-8206d22369df",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "18b16946-1af6-4417-b4a5-56436288d7b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "63504308-0663-436e-9568-6c85d44965c4",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "951a6b7d-b648-48d8-aa9d-545155585423",
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"StateType": {
"StateTypeId": "6508703f-9d42-4e99-a5b0-9581b26dc2c4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2bb47932-04cc-4832-b6b2-a3003d0a6089",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "087c73cd-1170-4030-b321-8206d22369df",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6353140d-88f6-4d23-9958-62d4d24939eb",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "501689ee-fb6f-4769-94d4-4e1224ac02e0",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4c4232eb-fe1b-4d1e-bb5b-15dc6be7add5",
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"StatusType": {
"StatusTypeId": "2d17fd73-fac8-4214-bc65-186ec7aa5ee1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2bb47932-04cc-4832-b6b2-a3003d0a6089",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "087c73cd-1170-4030-b321-8206d22369df",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "24e8ac21-f4bc-414a-bb28-f550c7e4de8d",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "04019fb1-ab09-416f-8236-5dd345865f70",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b832585a-0ec3-4af4-9423-b3d17af9f8a6",
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e303194d-7899-407a-970e-d65850550595",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5616de5c-1f35-402a-8ac4-fd57688b98a6",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0bd527d6-9cf8-4331-865f-810bb7fa549c",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4eccaa31-d70a-43f5-afad-6e2c82b57953",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b0216cb4-c754-4ff6-99a9-5df47d1ea53f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "67763f79-ed10-4cf7-9911-19d3ff34016e",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1c9125ca-848c-4e92-8ed1-bdf92208d7b0",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "33c409f5-b814-4420-b33f-7708f0b2ba41",
"Asset": {
"AssetId": "d904c466-b7ea-42b1-9559-0f1b22ee6d74",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2bb47932-04cc-4832-b6b2-a3003d0a6089",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "087c73cd-1170-4030-b321-8206d22369df",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "18b16946-1af6-4417-b4a5-56436288d7b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "63504308-0663-436e-9568-6c85d44965c4",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "951a6b7d-b648-48d8-aa9d-545155585423",
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"StateType": {
"StateTypeId": "6508703f-9d42-4e99-a5b0-9581b26dc2c4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2bb47932-04cc-4832-b6b2-a3003d0a6089",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "087c73cd-1170-4030-b321-8206d22369df",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6353140d-88f6-4d23-9958-62d4d24939eb",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "501689ee-fb6f-4769-94d4-4e1224ac02e0",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4c4232eb-fe1b-4d1e-bb5b-15dc6be7add5",
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"StatusType": {
"StatusTypeId": "2d17fd73-fac8-4214-bc65-186ec7aa5ee1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2bb47932-04cc-4832-b6b2-a3003d0a6089",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "087c73cd-1170-4030-b321-8206d22369df",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "24e8ac21-f4bc-414a-bb28-f550c7e4de8d",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "04019fb1-ab09-416f-8236-5dd345865f70",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b832585a-0ec3-4af4-9423-b3d17af9f8a6",
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e303194d-7899-407a-970e-d65850550595",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5616de5c-1f35-402a-8ac4-fd57688b98a6",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0bd527d6-9cf8-4331-865f-810bb7fa549c",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:14.6592259-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4eccaa31-d70a-43f5-afad-6e2c82b57953",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b0216cb4-c754-4ff6-99a9-5df47d1ea53f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "67763f79-ed10-4cf7-9911-19d3ff34016e",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-11T11:20:14.6592259-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1c9125ca-848c-4e92-8ed1-bdf92208d7b0",
"CreateDate": "2026-05-11T11:20:14.6592259-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:14.6592259-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}