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": "1fcc7684-237c-452b-8503-5683e34a4619", "Asset": { "AssetId": "071d19fe-78c6-43b7-a2eb-beba9e5a96bf", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6b552d05-4942-4525-bfc9-6006127b7b74", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4ea6e2f-cb88-426b-a18d-ec1883ca12e0", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "96717fac-5259-4601-bfe4-30509912a9e6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a4c01ea4-2ac8-40a3-ac3b-358b099551ad", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4d379062-3d85-4ba3-a1c3-5d1cd375f9f1", "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "StateType": { "StateTypeId": "bcec97e5-5c70-438b-b209-f43acd02fab9", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6b552d05-4942-4525-bfc9-6006127b7b74", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4ea6e2f-cb88-426b-a18d-ec1883ca12e0", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "643fc4c4-5f4d-45bf-b8c3-0e54a5c5b3ff", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "72b886a6-68e8-47f2-af28-6af49a137b43", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "8efa9d30-7ff3-4b19-8376-8c75431dd06b", "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "StatusType": { "StatusTypeId": "97710a99-38e1-46a9-ba87-52b0fceb7cf2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6b552d05-4942-4525-bfc9-6006127b7b74", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4ea6e2f-cb88-426b-a18d-ec1883ca12e0", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c694b8b9-cad8-492e-ae96-2f05a418247e", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "dd8762c8-cab1-4bf9-b95a-78d8fec6fdca", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "bdf61a37-08a5-48d1-87f7-9da0a33277ed", "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "WellPurposeType": { "WellPurposeTypeId": "a9a1ca62-1e25-497a-b60b-5d4f8886c0ed", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f1d5a7c9-a677-4d36-89f8-5ce922d2bcac", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "57bbf8c1-9d28-435e-9936-565aa7f24caf", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "094dfcf3-34fd-4fef-8ff3-7c6cd7b5efce", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "8c133deb-4a8b-42eb-ba89-9cf3d10b9f56", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "02176e58-34d5-446e-8de0-e3d31d40a12d", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0bc85c1a-5a71-48f3-85c0-70e591924c8a", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "1fcc7684-237c-452b-8503-5683e34a4619", "Asset": { "AssetId": "071d19fe-78c6-43b7-a2eb-beba9e5a96bf", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6b552d05-4942-4525-bfc9-6006127b7b74", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4ea6e2f-cb88-426b-a18d-ec1883ca12e0", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "96717fac-5259-4601-bfe4-30509912a9e6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a4c01ea4-2ac8-40a3-ac3b-358b099551ad", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4d379062-3d85-4ba3-a1c3-5d1cd375f9f1", "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "StateType": { "StateTypeId": "bcec97e5-5c70-438b-b209-f43acd02fab9", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6b552d05-4942-4525-bfc9-6006127b7b74", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4ea6e2f-cb88-426b-a18d-ec1883ca12e0", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "643fc4c4-5f4d-45bf-b8c3-0e54a5c5b3ff", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "72b886a6-68e8-47f2-af28-6af49a137b43", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "8efa9d30-7ff3-4b19-8376-8c75431dd06b", "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "StatusType": { "StatusTypeId": "97710a99-38e1-46a9-ba87-52b0fceb7cf2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6b552d05-4942-4525-bfc9-6006127b7b74", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4ea6e2f-cb88-426b-a18d-ec1883ca12e0", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c694b8b9-cad8-492e-ae96-2f05a418247e", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "dd8762c8-cab1-4bf9-b95a-78d8fec6fdca", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "bdf61a37-08a5-48d1-87f7-9da0a33277ed", "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "WellPurposeType": { "WellPurposeTypeId": "a9a1ca62-1e25-497a-b60b-5d4f8886c0ed", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f1d5a7c9-a677-4d36-89f8-5ce922d2bcac", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "57bbf8c1-9d28-435e-9936-565aa7f24caf", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.0784601-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "094dfcf3-34fd-4fef-8ff3-7c6cd7b5efce", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "8c133deb-4a8b-42eb-ba89-9cf3d10b9f56", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "02176e58-34d5-446e-8de0-e3d31d40a12d", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-08-29T17:15:14.0784601-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0bc85c1a-5a71-48f3-85c0-70e591924c8a", "CreateDate": "2025-08-29T17:15:14.0784601-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.0784601-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }