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": "01d91e47-d522-44c5-bda3-38622c9d1375", "Asset": { "AssetId": "277ba92e-836e-43d8-a01d-00a5cb2c91fa", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c7115cca-7634-416e-834b-a6fe6c032c0e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22bc8b40-1547-4db0-948c-dfb1eb6ab3d2", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "dc5d1428-b794-42b9-ad3e-28b8e7336123", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "MeasurementValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a62f5d9d-22ba-49c1-be55-7a1c2fdd2a5f", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1977a8e9-167d-4b74-b176-6bd8eacdafbe", "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "StateType": { "StateTypeId": "e47aa149-fbb6-47e5-81c8-bf00ff729ed4", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "c7115cca-7634-416e-834b-a6fe6c032c0e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22bc8b40-1547-4db0-948c-dfb1eb6ab3d2", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c60c6f87-a055-4c30-bed2-591669b4f8cd", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d26225c7-2d55-4b1f-b7b6-b0e414b161a8", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5185f2cb-f6c2-4b39-89fb-5d3a06bd94a8", "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "StatusType": { "StatusTypeId": "8eca5689-ede3-49cc-8230-181beffda102", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "c7115cca-7634-416e-834b-a6fe6c032c0e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22bc8b40-1547-4db0-948c-dfb1eb6ab3d2", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "9f3990f6-6d08-4f44-9afa-d3b8215d205b", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "60c24b42-44b2-4524-b275-87e77bb7cbaa", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c14dca6b-fe5a-47d0-95ee-21c1d43b497d", "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "WellPurposeType": { "WellPurposeTypeId": "fea602f9-e00b-4226-a75b-5219e3faee21", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "99cb702f-bbf6-4d8c-8ec9-eeb8a2eb040a", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d84fc2d6-9dd6-4265-a094-29f448e4fa6c", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "MeasurementValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3c0b93f3-2982-4d60-9d87-cf32506b4a28", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "eb6b7325-0ae4-466c-898e-2873e526d42b", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "9289fa45-1bad-4b06-af48-d4eebb6e5b36", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9e4d4d7b-c6e1-4b44-91e1-dc39334c2205", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "01d91e47-d522-44c5-bda3-38622c9d1375", "Asset": { "AssetId": "277ba92e-836e-43d8-a01d-00a5cb2c91fa", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c7115cca-7634-416e-834b-a6fe6c032c0e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22bc8b40-1547-4db0-948c-dfb1eb6ab3d2", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "dc5d1428-b794-42b9-ad3e-28b8e7336123", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "MeasurementValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a62f5d9d-22ba-49c1-be55-7a1c2fdd2a5f", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1977a8e9-167d-4b74-b176-6bd8eacdafbe", "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "StateType": { "StateTypeId": "e47aa149-fbb6-47e5-81c8-bf00ff729ed4", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "c7115cca-7634-416e-834b-a6fe6c032c0e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22bc8b40-1547-4db0-948c-dfb1eb6ab3d2", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c60c6f87-a055-4c30-bed2-591669b4f8cd", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d26225c7-2d55-4b1f-b7b6-b0e414b161a8", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5185f2cb-f6c2-4b39-89fb-5d3a06bd94a8", "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "StatusType": { "StatusTypeId": "8eca5689-ede3-49cc-8230-181beffda102", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "c7115cca-7634-416e-834b-a6fe6c032c0e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22bc8b40-1547-4db0-948c-dfb1eb6ab3d2", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "9f3990f6-6d08-4f44-9afa-d3b8215d205b", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "60c24b42-44b2-4524-b275-87e77bb7cbaa", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c14dca6b-fe5a-47d0-95ee-21c1d43b497d", "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "WellPurposeType": { "WellPurposeTypeId": "fea602f9-e00b-4226-a75b-5219e3faee21", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "99cb702f-bbf6-4d8c-8ec9-eeb8a2eb040a", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d84fc2d6-9dd6-4265-a094-29f448e4fa6c", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "MeasurementValueNeededDate": "2025-03-09T04:19:20.9347762-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3c0b93f3-2982-4d60-9d87-cf32506b4a28", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "eb6b7325-0ae4-466c-898e-2873e526d42b", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "9289fa45-1bad-4b06-af48-d4eebb6e5b36", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-03-09T04:19:20.9347762-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9e4d4d7b-c6e1-4b44-91e1-dc39334c2205", "CreateDate": "2025-03-09T04:19:20.9347762-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T04:19:20.9347762-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }