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": "3701a258-dd68-48f6-8b62-5cd3766c195c", "Asset": { "AssetId": "8c92b937-e8c9-4cad-b2fc-211cef7c6481", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fd96ee2b-253b-4f4e-853e-d6d37092966e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5ffa8966-b4a1-4d55-9816-8e0d1e759ffd", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e0acb279-0e4f-4939-a637-ac38441e2046", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "MeasurementValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5021816-4ee3-4eb4-b83e-b8807b3ec64e", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "a8839163-fbd3-4b6f-b581-d688bb2804fe", "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "StateType": { "StateTypeId": "0a07c2eb-69bd-469d-910b-232117602654", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "fd96ee2b-253b-4f4e-853e-d6d37092966e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5ffa8966-b4a1-4d55-9816-8e0d1e759ffd", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "1eac50b0-e88a-4b80-a853-263cf1a5d6a7", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "9c964685-eda5-4684-bd3b-a9294c018f6f", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "747f7d74-a548-45f5-b44a-c4b20de2f316", "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "StatusType": { "StatusTypeId": "b4aab1a3-56e9-4835-afb7-90647e82123f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "fd96ee2b-253b-4f4e-853e-d6d37092966e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5ffa8966-b4a1-4d55-9816-8e0d1e759ffd", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "52ac1a04-dbd0-48a9-b2b2-202975728525", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c3f9d8b7-0bf2-40fe-8993-738a2ce71be1", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "332fa907-bcbf-4c56-9516-73e482744c6c", "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "WellPurposeType": { "WellPurposeTypeId": "af004473-7316-466b-b94d-4b555fdd9447", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "549d5c62-7af2-4e51-b0fc-0d1fdb4a62da", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9996e635-7dde-4524-868f-a24659f9443e", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "MeasurementValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d08f737a-b96b-4c4c-b7ea-9467a0042dd2", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "42d70950-fe0a-4b7f-bdf1-2a9a1b9bcac8", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3b6a29c6-49f5-45b9-9564-27fc9318035d", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "22dda492-6795-42d0-87ca-a30ee7aa67a1", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "3701a258-dd68-48f6-8b62-5cd3766c195c", "Asset": { "AssetId": "8c92b937-e8c9-4cad-b2fc-211cef7c6481", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fd96ee2b-253b-4f4e-853e-d6d37092966e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5ffa8966-b4a1-4d55-9816-8e0d1e759ffd", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e0acb279-0e4f-4939-a637-ac38441e2046", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "MeasurementValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5021816-4ee3-4eb4-b83e-b8807b3ec64e", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "a8839163-fbd3-4b6f-b581-d688bb2804fe", "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "StateType": { "StateTypeId": "0a07c2eb-69bd-469d-910b-232117602654", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "fd96ee2b-253b-4f4e-853e-d6d37092966e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5ffa8966-b4a1-4d55-9816-8e0d1e759ffd", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "1eac50b0-e88a-4b80-a853-263cf1a5d6a7", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "9c964685-eda5-4684-bd3b-a9294c018f6f", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "747f7d74-a548-45f5-b44a-c4b20de2f316", "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "StatusType": { "StatusTypeId": "b4aab1a3-56e9-4835-afb7-90647e82123f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "fd96ee2b-253b-4f4e-853e-d6d37092966e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5ffa8966-b4a1-4d55-9816-8e0d1e759ffd", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "52ac1a04-dbd0-48a9-b2b2-202975728525", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c3f9d8b7-0bf2-40fe-8993-738a2ce71be1", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "332fa907-bcbf-4c56-9516-73e482744c6c", "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "WellPurposeType": { "WellPurposeTypeId": "af004473-7316-466b-b94d-4b555fdd9447", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "549d5c62-7af2-4e51-b0fc-0d1fdb4a62da", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9996e635-7dde-4524-868f-a24659f9443e", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "MeasurementValueNeededDate": "2025-06-27T00:03:31.6655045-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d08f737a-b96b-4c4c-b7ea-9467a0042dd2", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "42d70950-fe0a-4b7f-bdf1-2a9a1b9bcac8", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3b6a29c6-49f5-45b9-9564-27fc9318035d", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-06-27T00:03:31.6655045-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "22dda492-6795-42d0-87ca-a30ee7aa67a1", "CreateDate": "2025-06-27T00:03:31.6655045-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T00:03:31.6655045-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }