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": "25dc435d-dbf3-4e25-91cf-657abfab6cc7",
"Asset": {
"AssetId": "e855810c-ae20-43ce-a3b7-1fed8a86a6c6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2fa02f04-7575-46cb-aae3-45d4bd210393",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac310c3b-3eb7-4590-b61f-bafd2b48bb76",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2d17d120-939d-4314-a84e-4f88f8c8499b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"MeasurementValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bdaebd19-dbb2-4792-8a9b-aea436be21db",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c7260abb-19f5-4974-b21d-738af27a3565",
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"StateType": {
"StateTypeId": "fedbb76b-7e5e-4498-9e4d-2626cccf5c17",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2fa02f04-7575-46cb-aae3-45d4bd210393",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac310c3b-3eb7-4590-b61f-bafd2b48bb76",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ad85870b-a84d-45b1-b689-9cfa5ae69471",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0c6095c5-2eea-44a9-af49-b4ad1d7d5f50",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e31e2e24-fcfb-47be-8d93-94472a665569",
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"StatusType": {
"StatusTypeId": "8f801d4e-83a4-4cb3-bd53-9845243fa670",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2fa02f04-7575-46cb-aae3-45d4bd210393",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac310c3b-3eb7-4590-b61f-bafd2b48bb76",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b48faf4d-2428-4a80-ad1b-907f967afb97",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46c52963-1cb1-4884-bd9c-bc74ae618aba",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1bce7199-7445-4e85-83a0-c08d51dd64eb",
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b4241540-5bfc-4095-8da6-a9d7dbfa3d9f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dcbea1ae-e94c-43d4-90e0-88828b31d56d",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "65c077c6-cf2e-40b5-bef3-dc0b9bb7821f",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"MeasurementValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "45977583-7aa9-48ec-b76f-62db93835972",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "45861ee3-d85e-4a37-8450-5775c55551cb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa4e6e94-a1f9-4440-a036-3145b7c62517",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0777bffb-c54e-4edf-b1ad-48acdc512e12",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "25dc435d-dbf3-4e25-91cf-657abfab6cc7",
"Asset": {
"AssetId": "e855810c-ae20-43ce-a3b7-1fed8a86a6c6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2fa02f04-7575-46cb-aae3-45d4bd210393",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac310c3b-3eb7-4590-b61f-bafd2b48bb76",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2d17d120-939d-4314-a84e-4f88f8c8499b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"MeasurementValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bdaebd19-dbb2-4792-8a9b-aea436be21db",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c7260abb-19f5-4974-b21d-738af27a3565",
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"StateType": {
"StateTypeId": "fedbb76b-7e5e-4498-9e4d-2626cccf5c17",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2fa02f04-7575-46cb-aae3-45d4bd210393",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac310c3b-3eb7-4590-b61f-bafd2b48bb76",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ad85870b-a84d-45b1-b689-9cfa5ae69471",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0c6095c5-2eea-44a9-af49-b4ad1d7d5f50",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e31e2e24-fcfb-47be-8d93-94472a665569",
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"StatusType": {
"StatusTypeId": "8f801d4e-83a4-4cb3-bd53-9845243fa670",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2fa02f04-7575-46cb-aae3-45d4bd210393",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ac310c3b-3eb7-4590-b61f-bafd2b48bb76",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b48faf4d-2428-4a80-ad1b-907f967afb97",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46c52963-1cb1-4884-bd9c-bc74ae618aba",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1bce7199-7445-4e85-83a0-c08d51dd64eb",
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b4241540-5bfc-4095-8da6-a9d7dbfa3d9f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dcbea1ae-e94c-43d4-90e0-88828b31d56d",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "65c077c6-cf2e-40b5-bef3-dc0b9bb7821f",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"MeasurementValueNeededDate": "2026-03-30T15:06:44.3910141-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "45977583-7aa9-48ec-b76f-62db93835972",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "45861ee3-d85e-4a37-8450-5775c55551cb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa4e6e94-a1f9-4440-a036-3145b7c62517",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-30T15:06:44.3910141-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0777bffb-c54e-4edf-b1ad-48acdc512e12",
"CreateDate": "2026-03-30T15:06:44.3910141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T15:06:44.3910141-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}