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": "3257f875-a5f2-4dfa-af98-afe733085c44",
"Asset": {
"AssetId": "5529535a-5bc3-4132-948e-6c1d6839ec06",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b1bd4607-4626-4dca-b976-32da42b2a8a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3def1ac-bc04-4b5b-993f-8bcb13d7c2e9",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "759e38ca-de46-40e3-9950-f67857ad69be",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "449b6db3-38d2-4d3e-b4d7-5946bb8fef41",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "07c782d8-502a-41c2-9565-e303a0e54fd1",
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"StateType": {
"StateTypeId": "e7fd613f-496e-42f3-82c8-d9c161315f97",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b1bd4607-4626-4dca-b976-32da42b2a8a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3def1ac-bc04-4b5b-993f-8bcb13d7c2e9",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0432aea5-8e14-4c8e-925b-12440a8f5b16",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2fdf3e30-177b-4c63-b599-815461694e62",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e1b49533-b3cb-41d4-afd4-329c3ccf7e91",
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"StatusType": {
"StatusTypeId": "853bacc5-5efa-4983-b18a-b943970e01ea",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b1bd4607-4626-4dca-b976-32da42b2a8a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3def1ac-bc04-4b5b-993f-8bcb13d7c2e9",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "30bece2c-ea37-4817-b4a2-187e5ada02f2",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5f1756a5-cf5d-44c8-8093-880b62dc6969",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1e000775-fe42-49cd-b1ae-abac1e4a26cb",
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f6d59fe5-87bd-4672-ac3b-877efa68eb79",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4ee62700-6977-4507-8e86-82aa2b758322",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "37445450-4cf2-40cc-94ab-e4c177acdecf",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6b64eaff-9b62-410b-9c29-f35f6e5a97cd",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "931e6e62-1118-4fe0-82c3-323a6c7c21e2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2ddfcd69-ee15-4421-bbd2-bdbecf6a59a8",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5142376e-fdbd-47fd-8eb2-885f614fee4a",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "3257f875-a5f2-4dfa-af98-afe733085c44",
"Asset": {
"AssetId": "5529535a-5bc3-4132-948e-6c1d6839ec06",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b1bd4607-4626-4dca-b976-32da42b2a8a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3def1ac-bc04-4b5b-993f-8bcb13d7c2e9",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "759e38ca-de46-40e3-9950-f67857ad69be",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "449b6db3-38d2-4d3e-b4d7-5946bb8fef41",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "07c782d8-502a-41c2-9565-e303a0e54fd1",
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"StateType": {
"StateTypeId": "e7fd613f-496e-42f3-82c8-d9c161315f97",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b1bd4607-4626-4dca-b976-32da42b2a8a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3def1ac-bc04-4b5b-993f-8bcb13d7c2e9",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0432aea5-8e14-4c8e-925b-12440a8f5b16",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2fdf3e30-177b-4c63-b599-815461694e62",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e1b49533-b3cb-41d4-afd4-329c3ccf7e91",
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"StatusType": {
"StatusTypeId": "853bacc5-5efa-4983-b18a-b943970e01ea",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b1bd4607-4626-4dca-b976-32da42b2a8a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e3def1ac-bc04-4b5b-993f-8bcb13d7c2e9",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "30bece2c-ea37-4817-b4a2-187e5ada02f2",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5f1756a5-cf5d-44c8-8093-880b62dc6969",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1e000775-fe42-49cd-b1ae-abac1e4a26cb",
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f6d59fe5-87bd-4672-ac3b-877efa68eb79",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4ee62700-6977-4507-8e86-82aa2b758322",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "37445450-4cf2-40cc-94ab-e4c177acdecf",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:37:55.8769785-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6b64eaff-9b62-410b-9c29-f35f6e5a97cd",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "931e6e62-1118-4fe0-82c3-323a6c7c21e2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2ddfcd69-ee15-4421-bbd2-bdbecf6a59a8",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T21:37:55.8769785-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5142376e-fdbd-47fd-8eb2-885f614fee4a",
"CreateDate": "2026-08-24T21:37:55.8769785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:37:55.8769785-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}