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": "f89b3375-af02-43cf-8de0-900b287dce8f",
"Asset": {
"AssetId": "4ee58994-852d-46ce-ac80-cfe03af3d73c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b2b36a98-8d7b-43f0-9ac6-9287b7925540",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4213c210-763e-4d8c-bc1f-534c4ded66df",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6ab51b27-a1b0-40e3-b3fb-c036f9e2fae8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"MeasurementValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b0099be0-dd56-42d9-a056-5f4f84a43ff3",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c2d24523-338c-44fa-9c3f-bdfe86b14e9f",
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"StateType": {
"StateTypeId": "15d4181c-72c9-47cf-b305-ce004c951a0a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b2b36a98-8d7b-43f0-9ac6-9287b7925540",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4213c210-763e-4d8c-bc1f-534c4ded66df",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "37fc0ee6-0c7d-4371-a6c5-de0666253844",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25a54013-3cca-4f4f-a1b1-f9449538171e",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cb0e70e2-4ecf-4f04-ada6-ff84ee91a84d",
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"StatusType": {
"StatusTypeId": "a08dca71-84a8-432b-b51a-593e9a90d7e8",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b2b36a98-8d7b-43f0-9ac6-9287b7925540",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4213c210-763e-4d8c-bc1f-534c4ded66df",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "401c98bd-ced5-402a-83fa-02396b666f6e",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "add49c20-5526-4ea9-9fd0-c8980aa9f06f",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e2a637c2-23d6-4821-9ed4-84b02ab64ffe",
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c3ea8406-be4f-4d9d-8035-84515297af38",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1ea15e6e-e3e6-474a-8fbd-da85b1e23b82",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "773473fb-908c-4674-a533-3b6637a41b2f",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"MeasurementValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a709f455-9aa9-4cd3-a6dc-9d342bef6593",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6db80901-f4c2-4748-ba9f-2477d6154918",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "410a5c27-f00d-433f-925e-f7fc1123269a",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ccae0919-04d3-433e-a22c-4ed258e9a6b4",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "f89b3375-af02-43cf-8de0-900b287dce8f",
"Asset": {
"AssetId": "4ee58994-852d-46ce-ac80-cfe03af3d73c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b2b36a98-8d7b-43f0-9ac6-9287b7925540",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4213c210-763e-4d8c-bc1f-534c4ded66df",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6ab51b27-a1b0-40e3-b3fb-c036f9e2fae8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"MeasurementValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b0099be0-dd56-42d9-a056-5f4f84a43ff3",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c2d24523-338c-44fa-9c3f-bdfe86b14e9f",
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"StateType": {
"StateTypeId": "15d4181c-72c9-47cf-b305-ce004c951a0a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b2b36a98-8d7b-43f0-9ac6-9287b7925540",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4213c210-763e-4d8c-bc1f-534c4ded66df",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "37fc0ee6-0c7d-4371-a6c5-de0666253844",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25a54013-3cca-4f4f-a1b1-f9449538171e",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cb0e70e2-4ecf-4f04-ada6-ff84ee91a84d",
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"StatusType": {
"StatusTypeId": "a08dca71-84a8-432b-b51a-593e9a90d7e8",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b2b36a98-8d7b-43f0-9ac6-9287b7925540",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4213c210-763e-4d8c-bc1f-534c4ded66df",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "401c98bd-ced5-402a-83fa-02396b666f6e",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "add49c20-5526-4ea9-9fd0-c8980aa9f06f",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e2a637c2-23d6-4821-9ed4-84b02ab64ffe",
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c3ea8406-be4f-4d9d-8035-84515297af38",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1ea15e6e-e3e6-474a-8fbd-da85b1e23b82",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "773473fb-908c-4674-a533-3b6637a41b2f",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"MeasurementValueNeededDate": "2026-04-18T05:01:00.1525711-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a709f455-9aa9-4cd3-a6dc-9d342bef6593",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6db80901-f4c2-4748-ba9f-2477d6154918",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "410a5c27-f00d-433f-925e-f7fc1123269a",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-18T05:01:00.1525711-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ccae0919-04d3-433e-a22c-4ed258e9a6b4",
"CreateDate": "2026-04-18T05:01:00.1525711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T05:01:00.1525711-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}