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": "3863661c-b4f0-4b13-90f5-568cb9bc5dc1", "Asset": { "AssetId": "b95c0b68-5d04-4db6-a275-e628783664c7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cf575f23-7cfd-4e1f-9179-6560313fbf50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5f24a868-08af-447d-8636-f649ceee00cf", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "3a9b126a-ec97-477e-b8f4-21307da3871c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "MeasurementValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "SourceSystemId": "sample string 3", "CompanyId": "41777d59-4450-4139-8f18-371f72e39803", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8fdda7d2-53f0-46c6-8056-f059bfbd0d4c", "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "StateType": { "StateTypeId": "193469d8-a46a-47b3-bbe0-a8b84e8b8226", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cf575f23-7cfd-4e1f-9179-6560313fbf50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5f24a868-08af-447d-8636-f649ceee00cf", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "6e23a9c8-ac27-4afd-bdf8-9497a462d7ef", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "8f67c6b7-0028-4e3e-b60c-f28a6074d336", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "aa8ff9d9-4289-4f2d-9780-672e99a241ca", "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "StatusType": { "StatusTypeId": "d52a69b8-fba1-441d-b2dd-ecfcb1669d49", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cf575f23-7cfd-4e1f-9179-6560313fbf50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5f24a868-08af-447d-8636-f649ceee00cf", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "eb49e96f-df27-4309-a75f-f024272a99f6", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2b8d7bfc-2cc8-4908-983b-817deceaf49e", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5e35ab74-6ebc-4a39-bba9-cce40baa68aa", "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "WellPurposeType": { "WellPurposeTypeId": "7cde9573-5228-4d8a-b417-3b9d7f9c55af", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d5c1df7d-754f-4982-af22-5b5c6756a815", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f2bfd416-0049-4965-8e59-c8cdf3913e57", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "MeasurementValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "87e5749e-3491-4d5d-b039-17be453ca77f", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "b0a5bb31-366b-4055-be17-d6568b07993b", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "8beae41d-29d5-4d23-aff6-8fa89c4f7bee", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d70e91e3-b39c-41e7-a696-12b110607eec", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "3863661c-b4f0-4b13-90f5-568cb9bc5dc1", "Asset": { "AssetId": "b95c0b68-5d04-4db6-a275-e628783664c7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cf575f23-7cfd-4e1f-9179-6560313fbf50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5f24a868-08af-447d-8636-f649ceee00cf", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "3a9b126a-ec97-477e-b8f4-21307da3871c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "MeasurementValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "SourceSystemId": "sample string 3", "CompanyId": "41777d59-4450-4139-8f18-371f72e39803", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8fdda7d2-53f0-46c6-8056-f059bfbd0d4c", "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "StateType": { "StateTypeId": "193469d8-a46a-47b3-bbe0-a8b84e8b8226", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cf575f23-7cfd-4e1f-9179-6560313fbf50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5f24a868-08af-447d-8636-f649ceee00cf", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "6e23a9c8-ac27-4afd-bdf8-9497a462d7ef", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "8f67c6b7-0028-4e3e-b60c-f28a6074d336", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "aa8ff9d9-4289-4f2d-9780-672e99a241ca", "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "StatusType": { "StatusTypeId": "d52a69b8-fba1-441d-b2dd-ecfcb1669d49", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cf575f23-7cfd-4e1f-9179-6560313fbf50", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5f24a868-08af-447d-8636-f649ceee00cf", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "eb49e96f-df27-4309-a75f-f024272a99f6", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2b8d7bfc-2cc8-4908-983b-817deceaf49e", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5e35ab74-6ebc-4a39-bba9-cce40baa68aa", "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "WellPurposeType": { "WellPurposeTypeId": "7cde9573-5228-4d8a-b417-3b9d7f9c55af", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d5c1df7d-754f-4982-af22-5b5c6756a815", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f2bfd416-0049-4965-8e59-c8cdf3913e57", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "MeasurementValueNeededDate": "2025-09-13T18:35:43.5928604-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "87e5749e-3491-4d5d-b039-17be453ca77f", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "b0a5bb31-366b-4055-be17-d6568b07993b", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "8beae41d-29d5-4d23-aff6-8fa89c4f7bee", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-09-13T18:35:43.5928604-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d70e91e3-b39c-41e7-a696-12b110607eec", "CreateDate": "2025-09-13T18:35:43.5928604-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:35:43.5928604-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }