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": "305b6ce7-c7b2-4fcb-846b-3d08d4070f8d", "Asset": { "AssetId": "6e5a3b1e-de2b-4d38-a08f-1b135898b5ec", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a2fe4a73-b445-465b-ba9f-f6926d41662b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "277f6fcb-eff1-430b-98e6-dcf5b03d674d", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5f3bbf55-b711-4022-9b9e-83a94230115e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "MeasurementValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "SourceSystemId": "sample string 3", "CompanyId": "92339848-bad9-4743-b7ae-dd0a99c9e900", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "cd4551a9-c92b-4b6d-9c5e-c0516392876e", "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "StateType": { "StateTypeId": "25b16525-01f8-4989-a1eb-49245dfe5624", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a2fe4a73-b445-465b-ba9f-f6926d41662b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "277f6fcb-eff1-430b-98e6-dcf5b03d674d", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e29e7226-b5b7-41a3-9346-fa3ce2e210d8", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d3592207-0cdb-4229-bc41-23a63f7a8758", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5b76f8be-0bbb-4053-94d0-f78daeb5a9c5", "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "StatusType": { "StatusTypeId": "8b738db8-d31d-488b-ae62-9ccd0cb48db1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a2fe4a73-b445-465b-ba9f-f6926d41662b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "277f6fcb-eff1-430b-98e6-dcf5b03d674d", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "87936f8c-2291-4486-99be-6ddde2c0c12a", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3219198a-325b-4299-9daf-b48f2804b368", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "25a99cd3-4096-46fe-ad5e-cdf8babcf120", "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "WellPurposeType": { "WellPurposeTypeId": "3e05f191-fff8-4ea2-adf8-a281ea464bc1", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ad0dad3a-1f58-4a21-988b-18f3ab329d77", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1783cec7-c8a8-4523-bd9b-5e2256d1c2ec", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "MeasurementValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2498e9e4-4541-4a62-a58e-b084f628fc3a", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "3bc4e8e7-3f3f-4007-994b-84107dc34639", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "60f9cd57-2e84-46ca-98dd-8c8dcd009bc1", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9e8b5485-af66-4633-9845-41fac9b9a3e4", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 6" }, { "NoteId": "305b6ce7-c7b2-4fcb-846b-3d08d4070f8d", "Asset": { "AssetId": "6e5a3b1e-de2b-4d38-a08f-1b135898b5ec", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a2fe4a73-b445-465b-ba9f-f6926d41662b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "277f6fcb-eff1-430b-98e6-dcf5b03d674d", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5f3bbf55-b711-4022-9b9e-83a94230115e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "MeasurementValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "SourceSystemId": "sample string 3", "CompanyId": "92339848-bad9-4743-b7ae-dd0a99c9e900", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "cd4551a9-c92b-4b6d-9c5e-c0516392876e", "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "StateType": { "StateTypeId": "25b16525-01f8-4989-a1eb-49245dfe5624", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a2fe4a73-b445-465b-ba9f-f6926d41662b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "277f6fcb-eff1-430b-98e6-dcf5b03d674d", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e29e7226-b5b7-41a3-9346-fa3ce2e210d8", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d3592207-0cdb-4229-bc41-23a63f7a8758", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5b76f8be-0bbb-4053-94d0-f78daeb5a9c5", "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "StatusType": { "StatusTypeId": "8b738db8-d31d-488b-ae62-9ccd0cb48db1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a2fe4a73-b445-465b-ba9f-f6926d41662b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "277f6fcb-eff1-430b-98e6-dcf5b03d674d", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "87936f8c-2291-4486-99be-6ddde2c0c12a", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3219198a-325b-4299-9daf-b48f2804b368", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "25a99cd3-4096-46fe-ad5e-cdf8babcf120", "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "WellPurposeType": { "WellPurposeTypeId": "3e05f191-fff8-4ea2-adf8-a281ea464bc1", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ad0dad3a-1f58-4a21-988b-18f3ab329d77", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1783cec7-c8a8-4523-bd9b-5e2256d1c2ec", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "MeasurementValueNeededDate": "2025-01-02T11:01:06.7429542-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2498e9e4-4541-4a62-a58e-b084f628fc3a", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 8" }, "OnBehalfOf": "sample string 1", "NoteCategory": { "NoteCategoryId": "3bc4e8e7-3f3f-4007-994b-84107dc34639", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "60f9cd57-2e84-46ca-98dd-8c8dcd009bc1", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2025-01-02T11:01:06.7429542-08:00", "NoteHTML": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9e8b5485-af66-4633-9845-41fac9b9a3e4", "CreateDate": "2025-01-02T11:01:06.7429542-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:01:06.7429542-08:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }