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": "db635e24-93a7-40cb-b486-378280ad1277", "Asset": { "AssetId": "c1711cba-c41d-49df-9ca5-61ba6ccd0fa4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9f2a036b-3e4c-4b1a-a71c-fdf38105b612", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4eed6b17-83a9-4cdf-a301-4d9ea642d71f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "990049dd-8949-4a1d-bcbc-441f9d728377", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "MeasurementValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8cabb2ef-c19c-4c53-83ff-06d8ce1f6371", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "b49f1b9d-9937-401a-8e6c-201ce0c9d130", "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "StateType": { "StateTypeId": "b91b234a-b1a2-4b92-9d3e-4a1790bfb9a5", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9f2a036b-3e4c-4b1a-a71c-fdf38105b612", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4eed6b17-83a9-4cdf-a301-4d9ea642d71f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "8f861258-a82f-4fab-a759-d4d144445fd6", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "80d9b469-3cb4-4e38-8506-35cdb163b887", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "38863383-d484-4b74-a874-bc684419a026", "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "StatusType": { "StatusTypeId": "7981c121-b5a1-43d2-8d19-b1a30cc34666", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9f2a036b-3e4c-4b1a-a71c-fdf38105b612", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4eed6b17-83a9-4cdf-a301-4d9ea642d71f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "91b57025-b530-4f5e-adf4-fbc30745751c", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "beb67029-a672-41d4-ba97-3b89123e6a9f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "6d998d18-3a57-4353-bc18-8b596e3e87d8", "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "WellPurposeType": { "WellPurposeTypeId": "e8b78ad1-be27-45fe-b17a-ebff858e06a4", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7db253f6-b405-4881-bd03-80dbe0597f18", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "23d183fe-7e47-46a7-b57d-a535024e0b69", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "MeasurementValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5aa9fde8-fa79-4d6d-b9e4-120f7f86ac9f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "ddb6be09-205a-4503-929d-b26f9eb5ac8c", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "28c33bf6-4b9e-40f8-b059-844b68f104b5", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bd4b50db-ccc3-4cca-96cc-029abcd13747", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "db635e24-93a7-40cb-b486-378280ad1277", "Asset": { "AssetId": "c1711cba-c41d-49df-9ca5-61ba6ccd0fa4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9f2a036b-3e4c-4b1a-a71c-fdf38105b612", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4eed6b17-83a9-4cdf-a301-4d9ea642d71f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "990049dd-8949-4a1d-bcbc-441f9d728377", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "MeasurementValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8cabb2ef-c19c-4c53-83ff-06d8ce1f6371", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "b49f1b9d-9937-401a-8e6c-201ce0c9d130", "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "StateType": { "StateTypeId": "b91b234a-b1a2-4b92-9d3e-4a1790bfb9a5", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9f2a036b-3e4c-4b1a-a71c-fdf38105b612", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4eed6b17-83a9-4cdf-a301-4d9ea642d71f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "8f861258-a82f-4fab-a759-d4d144445fd6", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "80d9b469-3cb4-4e38-8506-35cdb163b887", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "38863383-d484-4b74-a874-bc684419a026", "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "StatusType": { "StatusTypeId": "7981c121-b5a1-43d2-8d19-b1a30cc34666", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9f2a036b-3e4c-4b1a-a71c-fdf38105b612", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4eed6b17-83a9-4cdf-a301-4d9ea642d71f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "91b57025-b530-4f5e-adf4-fbc30745751c", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "beb67029-a672-41d4-ba97-3b89123e6a9f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "6d998d18-3a57-4353-bc18-8b596e3e87d8", "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "WellPurposeType": { "WellPurposeTypeId": "e8b78ad1-be27-45fe-b17a-ebff858e06a4", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7db253f6-b405-4881-bd03-80dbe0597f18", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "23d183fe-7e47-46a7-b57d-a535024e0b69", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "MeasurementValueNeededDate": "2025-06-02T14:52:53.195745-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5aa9fde8-fa79-4d6d-b9e4-120f7f86ac9f", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "ddb6be09-205a-4503-929d-b26f9eb5ac8c", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "28c33bf6-4b9e-40f8-b059-844b68f104b5", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-06-02T14:52:53.195745-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bd4b50db-ccc3-4cca-96cc-029abcd13747", "CreateDate": "2025-06-02T14:52:53.195745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:52:53.195745-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }