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": "f419476b-bdc7-49c6-9816-feee28e22171", "Asset": { "AssetId": "765a3158-675b-466f-9324-1a780dac43cf", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7b9eddfa-ef28-4533-a44c-0df845d75a21", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ec78c5fd-68db-4e44-a611-d32a7fc62809", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "40fc5a83-2473-4548-b3f6-e37570350457", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "MeasurementValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9a969c83-9ff1-42a8-972b-e66b94104409", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "f1017912-cb9e-4e7e-99cd-426ec5c27991", "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "StateType": { "StateTypeId": "0f5955c9-5a97-4355-994a-cb62b8a70651", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7b9eddfa-ef28-4533-a44c-0df845d75a21", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ec78c5fd-68db-4e44-a611-d32a7fc62809", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "63f21452-c0e8-4c91-a319-eca8b64960a0", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5c7b1b1d-19d8-4b4c-b587-107c71f8dd51", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "2e8dda20-5c3e-41c0-a8b9-ab0b8e20f123", "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "StatusType": { "StatusTypeId": "368369e4-aaf7-47e2-8bb3-9baac9948c0b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7b9eddfa-ef28-4533-a44c-0df845d75a21", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ec78c5fd-68db-4e44-a611-d32a7fc62809", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "5b30d647-b224-42ec-b1a5-d6dacc105cb2", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9554ae0b-17bc-4c7d-ac05-392decb4179f", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "1fdd1435-90c7-43a6-abe2-54299d755a24", "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "WellPurposeType": { "WellPurposeTypeId": "7e6d8de1-3a49-4f6c-ba3f-c0dad213c4b9", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "378fdc78-ff35-4d07-83cb-62c43a01b23a", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "58192ba2-0a30-4519-bf5f-1498d1199255", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "MeasurementValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ad351388-f848-44ac-95ed-0da7c9d2181e", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "b46d2bda-566c-4fd4-8420-111cd41c11e7", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6023ecb0-3967-46d1-943f-0a2feb73baf0", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7b26dbdb-c3b0-4059-b88a-3124fe615c8f", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "f419476b-bdc7-49c6-9816-feee28e22171", "Asset": { "AssetId": "765a3158-675b-466f-9324-1a780dac43cf", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7b9eddfa-ef28-4533-a44c-0df845d75a21", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ec78c5fd-68db-4e44-a611-d32a7fc62809", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "40fc5a83-2473-4548-b3f6-e37570350457", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "MeasurementValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9a969c83-9ff1-42a8-972b-e66b94104409", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "f1017912-cb9e-4e7e-99cd-426ec5c27991", "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "StateType": { "StateTypeId": "0f5955c9-5a97-4355-994a-cb62b8a70651", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7b9eddfa-ef28-4533-a44c-0df845d75a21", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ec78c5fd-68db-4e44-a611-d32a7fc62809", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "63f21452-c0e8-4c91-a319-eca8b64960a0", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5c7b1b1d-19d8-4b4c-b587-107c71f8dd51", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "2e8dda20-5c3e-41c0-a8b9-ab0b8e20f123", "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "StatusType": { "StatusTypeId": "368369e4-aaf7-47e2-8bb3-9baac9948c0b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7b9eddfa-ef28-4533-a44c-0df845d75a21", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ec78c5fd-68db-4e44-a611-d32a7fc62809", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "5b30d647-b224-42ec-b1a5-d6dacc105cb2", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9554ae0b-17bc-4c7d-ac05-392decb4179f", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "1fdd1435-90c7-43a6-abe2-54299d755a24", "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "WellPurposeType": { "WellPurposeTypeId": "7e6d8de1-3a49-4f6c-ba3f-c0dad213c4b9", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "378fdc78-ff35-4d07-83cb-62c43a01b23a", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "58192ba2-0a30-4519-bf5f-1498d1199255", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "MeasurementValueNeededDate": "2025-07-30T23:21:14.4443105-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ad351388-f848-44ac-95ed-0da7c9d2181e", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "b46d2bda-566c-4fd4-8420-111cd41c11e7", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6023ecb0-3967-46d1-943f-0a2feb73baf0", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-07-30T23:21:14.4443105-07:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7b26dbdb-c3b0-4059-b88a-3124fe615c8f", "CreateDate": "2025-07-30T23:21:14.4443105-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:21:14.4443105-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }