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": "8c815c60-05a0-4031-a6eb-3c35fe2ce86f", "Asset": { "AssetId": "4ef77a80-8100-404e-994c-38cdbafcdae7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6af468ee-cc2a-4777-b30d-fe7ca91ff452", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8d9b42fa-de44-46ef-b335-0fadb5a173f9", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0c2c25ae-9639-402e-b58f-f330a36f70e1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T17:21:58.1164067-07:00", "MeasurementValueNeededDate": "2024-04-28T17:21:58.1164067-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1e136e45-0739-45a8-a61a-0ef6773ead61", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "038e1b19-e5f7-4bb4-8eff-f4db8f9244a9", "EffectiveDate": "2024-04-28T17:21:58.1164067-07:00", "StateType": { "StateTypeId": "476e4b37-4147-4de6-a290-d8d943219494", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6af468ee-cc2a-4777-b30d-fe7ca91ff452", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8d9b42fa-de44-46ef-b335-0fadb5a173f9", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "b4657512-9beb-44d0-8217-3d337734c905", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "020690cc-249e-4a7a-b2dc-808cfda0fc53", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "29bb571b-3964-410d-9aef-01c3e9e06640", "EffectiveDate": "2024-04-28T17:21:58.1164067-07:00", "StatusType": { "StatusTypeId": "8fe18c74-d916-4d09-84e5-62c23a46d980", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6af468ee-cc2a-4777-b30d-fe7ca91ff452", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8d9b42fa-de44-46ef-b335-0fadb5a173f9", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "45de2771-f16d-4e4b-a536-9be4a8917b1f", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0910ae13-3526-4b5f-bab7-ff8bb4cea04f", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "de13d45c-516e-4756-b168-6ca13815c4e5", "EffectiveDate": "2024-04-28T17:21:58.1164067-07:00", "WellPurposeType": { "WellPurposeTypeId": "0029779d-07e2-4107-bcc7-b0f3d31c4d56", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "df0046c7-a544-42e9-ae9a-e293204ab252", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2a48eca5-bc66-471d-acb0-889e2b20d72c", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T17:21:58.1320195-07:00", "MeasurementValueNeededDate": "2024-04-28T17:21:58.1320195-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "1b90ea66-9337-4caf-8d36-808009cf4ac2", "CreateDate": "2024-04-28T17:21:58.1320195-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "dbb29bc8-0ec9-4441-9858-d5f1e51b1971", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f5a05fde-2504-48b7-bf98-6be972a2652c", "CreateDate": "2024-04-28T17:21:58.1320195-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-28T17:21:58.1320195-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5fb9d8c8-4fd6-4a4d-8f34-166d1d7af78e", "CreateDate": "2024-04-28T17:21:58.1320195-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "8c815c60-05a0-4031-a6eb-3c35fe2ce86f", "Asset": { "AssetId": "4ef77a80-8100-404e-994c-38cdbafcdae7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6af468ee-cc2a-4777-b30d-fe7ca91ff452", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8d9b42fa-de44-46ef-b335-0fadb5a173f9", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0c2c25ae-9639-402e-b58f-f330a36f70e1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T17:21:58.1164067-07:00", "MeasurementValueNeededDate": "2024-04-28T17:21:58.1164067-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1e136e45-0739-45a8-a61a-0ef6773ead61", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "038e1b19-e5f7-4bb4-8eff-f4db8f9244a9", "EffectiveDate": "2024-04-28T17:21:58.1164067-07:00", "StateType": { "StateTypeId": "476e4b37-4147-4de6-a290-d8d943219494", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6af468ee-cc2a-4777-b30d-fe7ca91ff452", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8d9b42fa-de44-46ef-b335-0fadb5a173f9", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "b4657512-9beb-44d0-8217-3d337734c905", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "020690cc-249e-4a7a-b2dc-808cfda0fc53", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "29bb571b-3964-410d-9aef-01c3e9e06640", "EffectiveDate": "2024-04-28T17:21:58.1164067-07:00", "StatusType": { "StatusTypeId": "8fe18c74-d916-4d09-84e5-62c23a46d980", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6af468ee-cc2a-4777-b30d-fe7ca91ff452", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8d9b42fa-de44-46ef-b335-0fadb5a173f9", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "45de2771-f16d-4e4b-a536-9be4a8917b1f", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0910ae13-3526-4b5f-bab7-ff8bb4cea04f", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "de13d45c-516e-4756-b168-6ca13815c4e5", "EffectiveDate": "2024-04-28T17:21:58.1164067-07:00", "WellPurposeType": { "WellPurposeTypeId": "0029779d-07e2-4107-bcc7-b0f3d31c4d56", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "df0046c7-a544-42e9-ae9a-e293204ab252", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T17:21:58.1164067-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "2a48eca5-bc66-471d-acb0-889e2b20d72c", "CreateDate": "2024-04-28T17:21:58.1164067-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T17:21:58.1320195-07:00", "MeasurementValueNeededDate": "2024-04-28T17:21:58.1320195-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "1b90ea66-9337-4caf-8d36-808009cf4ac2", "CreateDate": "2024-04-28T17:21:58.1320195-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "dbb29bc8-0ec9-4441-9858-d5f1e51b1971", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f5a05fde-2504-48b7-bf98-6be972a2652c", "CreateDate": "2024-04-28T17:21:58.1320195-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-28T17:21:58.1320195-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5fb9d8c8-4fd6-4a4d-8f34-166d1d7af78e", "CreateDate": "2024-04-28T17:21:58.1320195-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T17:21:58.1320195-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }