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": "c94d4239-f491-4de2-b906-6d717f1bf685", "Asset": { "AssetId": "01ca8c11-9aae-4b9f-9e85-0ae752efa603", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8311a7b0-546e-4c85-8cd4-de17ccc353f8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a97ca862-06f8-4c18-bb48-a27c9417576f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "a22bec07-cb06-4df6-af5d-d69db964ac5d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "MeasurementValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "22c5a18d-b4f8-4185-9df2-a92838f7e26f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "62341bb7-260b-482e-8e6b-187c3de9401a", "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "StateType": { "StateTypeId": "9477a65d-4703-46a8-b294-6c32f4e7b1fd", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8311a7b0-546e-4c85-8cd4-de17ccc353f8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a97ca862-06f8-4c18-bb48-a27c9417576f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0ef5be43-89b6-4d74-a6b2-307ac1ea57d2", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "050429f4-ac7b-435a-9da5-bc601509cf94", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "acbf263d-08f2-4bd1-8721-231a86edafa1", "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "StatusType": { "StatusTypeId": "b298177a-8ee2-4353-9ea8-9366d59439a3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8311a7b0-546e-4c85-8cd4-de17ccc353f8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a97ca862-06f8-4c18-bb48-a27c9417576f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1e59a308-690a-400f-b9ae-cef839b15c90", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "14ce4eb6-a169-458a-9258-1c4d8b3d2b29", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "73286a41-1cd5-45ac-8ad1-9655dffe6724", "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "WellPurposeType": { "WellPurposeTypeId": "6f83f9d2-8c6b-4fa3-bc10-c62e34efdf72", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a9f1752-06ea-4c2e-93d4-46b043daa594", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2becaec7-818a-4bd0-8cb0-e9dfaa7b0134", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "MeasurementValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5d6d80b4-e7e0-4fff-8c15-f0cacf3bd6a5", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "55e86547-a4c7-4053-84a6-092ea202da50", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "77a915c3-78d7-4e63-b216-d51fd55419cc", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "61293472-49ad-431c-9e3e-a3c127c395b1", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "c94d4239-f491-4de2-b906-6d717f1bf685", "Asset": { "AssetId": "01ca8c11-9aae-4b9f-9e85-0ae752efa603", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8311a7b0-546e-4c85-8cd4-de17ccc353f8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a97ca862-06f8-4c18-bb48-a27c9417576f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "a22bec07-cb06-4df6-af5d-d69db964ac5d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "MeasurementValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "22c5a18d-b4f8-4185-9df2-a92838f7e26f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "62341bb7-260b-482e-8e6b-187c3de9401a", "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "StateType": { "StateTypeId": "9477a65d-4703-46a8-b294-6c32f4e7b1fd", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8311a7b0-546e-4c85-8cd4-de17ccc353f8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a97ca862-06f8-4c18-bb48-a27c9417576f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0ef5be43-89b6-4d74-a6b2-307ac1ea57d2", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "050429f4-ac7b-435a-9da5-bc601509cf94", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "acbf263d-08f2-4bd1-8721-231a86edafa1", "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "StatusType": { "StatusTypeId": "b298177a-8ee2-4353-9ea8-9366d59439a3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8311a7b0-546e-4c85-8cd4-de17ccc353f8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a97ca862-06f8-4c18-bb48-a27c9417576f", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1e59a308-690a-400f-b9ae-cef839b15c90", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "14ce4eb6-a169-458a-9258-1c4d8b3d2b29", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "73286a41-1cd5-45ac-8ad1-9655dffe6724", "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "WellPurposeType": { "WellPurposeTypeId": "6f83f9d2-8c6b-4fa3-bc10-c62e34efdf72", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a9f1752-06ea-4c2e-93d4-46b043daa594", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2becaec7-818a-4bd0-8cb0-e9dfaa7b0134", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "MeasurementValueNeededDate": "2025-04-17T04:13:40.8115623-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5d6d80b4-e7e0-4fff-8c15-f0cacf3bd6a5", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "55e86547-a4c7-4053-84a6-092ea202da50", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "77a915c3-78d7-4e63-b216-d51fd55419cc", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-04-17T04:13:40.8115623-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "61293472-49ad-431c-9e3e-a3c127c395b1", "CreateDate": "2025-04-17T04:13:40.8115623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-17T04:13:40.8115623-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }