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": "980847d7-ebc1-41a8-bdda-3d5555535adc", "Asset": { "AssetId": "38b61ef3-314e-4e5c-b7e9-2d00b68a4d92", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6efaaa3b-4644-49fb-a855-91fc14fd252f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17c9e2df-febf-45df-9e96-a2c5134d0d51", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "6ffb5665-4b80-4452-a26a-e7eff5c24fb5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "MeasurementValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c3ba2e47-f0b9-4316-9fe3-0cc419f7a0ea", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "aac8a482-9f49-4b75-acaa-7a08d058854e", "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "StateType": { "StateTypeId": "42d825fc-d562-4cc3-91db-18d9fe6e2c99", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6efaaa3b-4644-49fb-a855-91fc14fd252f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17c9e2df-febf-45df-9e96-a2c5134d0d51", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "654ebe2b-2f9d-4165-84df-8ff65ae5877a", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "380017d2-28ff-4a02-82ce-3c7f79e90f87", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3e60d35b-7744-4f5c-94b4-28ae7d2ea43c", "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "StatusType": { "StatusTypeId": "b91d3a56-3f2b-4557-b92e-c7f16470ba8c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6efaaa3b-4644-49fb-a855-91fc14fd252f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17c9e2df-febf-45df-9e96-a2c5134d0d51", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "89deb729-69d4-4bce-87af-956db714b44f", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e32335c1-b19c-4a55-a8f0-ef52c42af4c2", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "adeb36e1-6192-45e5-9a66-403d2a4d95a3", "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "WellPurposeType": { "WellPurposeTypeId": "1be7365c-6846-4fd1-aae0-2e4006750e66", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a9ed2db2-eb05-4f71-8540-3d524202bb27", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2bbfaf8b-4a1e-4308-91ab-5078417b6644", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "MeasurementValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "1c1114f5-72a4-4629-8f6a-2e378f582bba", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "302728e5-cfab-4a00-979f-429142252091", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "cf88330f-3099-4ec2-a47a-a2d2dbca67b6", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "476bf581-151c-4d06-8e3e-adc2f9731a41", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "980847d7-ebc1-41a8-bdda-3d5555535adc", "Asset": { "AssetId": "38b61ef3-314e-4e5c-b7e9-2d00b68a4d92", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6efaaa3b-4644-49fb-a855-91fc14fd252f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17c9e2df-febf-45df-9e96-a2c5134d0d51", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "6ffb5665-4b80-4452-a26a-e7eff5c24fb5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "MeasurementValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c3ba2e47-f0b9-4316-9fe3-0cc419f7a0ea", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "aac8a482-9f49-4b75-acaa-7a08d058854e", "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "StateType": { "StateTypeId": "42d825fc-d562-4cc3-91db-18d9fe6e2c99", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6efaaa3b-4644-49fb-a855-91fc14fd252f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17c9e2df-febf-45df-9e96-a2c5134d0d51", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "654ebe2b-2f9d-4165-84df-8ff65ae5877a", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "380017d2-28ff-4a02-82ce-3c7f79e90f87", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3e60d35b-7744-4f5c-94b4-28ae7d2ea43c", "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "StatusType": { "StatusTypeId": "b91d3a56-3f2b-4557-b92e-c7f16470ba8c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6efaaa3b-4644-49fb-a855-91fc14fd252f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17c9e2df-febf-45df-9e96-a2c5134d0d51", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "89deb729-69d4-4bce-87af-956db714b44f", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e32335c1-b19c-4a55-a8f0-ef52c42af4c2", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "adeb36e1-6192-45e5-9a66-403d2a4d95a3", "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "WellPurposeType": { "WellPurposeTypeId": "1be7365c-6846-4fd1-aae0-2e4006750e66", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a9ed2db2-eb05-4f71-8540-3d524202bb27", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2bbfaf8b-4a1e-4308-91ab-5078417b6644", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "MeasurementValueNeededDate": "2024-05-01T15:03:41.4597375-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "1c1114f5-72a4-4629-8f6a-2e378f582bba", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "302728e5-cfab-4a00-979f-429142252091", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "cf88330f-3099-4ec2-a47a-a2d2dbca67b6", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-01T15:03:41.4597375-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "476bf581-151c-4d06-8e3e-adc2f9731a41", "CreateDate": "2024-05-01T15:03:41.4597375-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T15:03:41.4597375-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }