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": "089d54fc-654e-4920-a1ce-6f932a86b44f",
"Asset": {
"AssetId": "96ba5fa6-5058-4c4c-a260-768444f96102",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "02142ac4-1f0d-4615-a4e0-494eda6612a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a44ec26-baf8-4d50-9f51-b964a99f1c03",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a9d82573-0926-4d96-a139-e5c86029014f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "95ae981f-8980-4cc2-86cd-cd4e56edb72b",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "0b98ba81-857a-4624-b86f-53564166d755",
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"StateType": {
"StateTypeId": "f243feb2-02f0-4dff-8c46-690cc2df26e9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "02142ac4-1f0d-4615-a4e0-494eda6612a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a44ec26-baf8-4d50-9f51-b964a99f1c03",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b57a1da2-1dc2-4f4f-88a1-652e5abbc0ec",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0faf3fb-ef98-414e-9089-c612b3388aa9",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b49cc100-a3ff-43f9-be53-56ccb8012e07",
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"StatusType": {
"StatusTypeId": "1e477745-1e27-45a9-a1ce-efa51f14e321",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "02142ac4-1f0d-4615-a4e0-494eda6612a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a44ec26-baf8-4d50-9f51-b964a99f1c03",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3cbd8aa1-6d0f-42f8-b7e5-09a21bdf430a",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3bf68467-f9a5-4a2f-aa3a-dfe40d0a3dc6",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "61653848-f987-478a-b130-c53a034d2e9d",
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "17c8a004-7671-426d-b84c-a376752ef908",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "32c72e2b-1234-4b42-a4fb-327f7d9882cf",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e7dbac99-9399-43b8-9f30-9fe298fb7733",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "72e6f535-f2d9-41f3-98c1-4b9ffac41485",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a9f685a6-075f-4838-9301-cdac4be39354",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f2d6c1e2-0dbe-4bc8-83a7-ea0d28441828",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "73131cc0-d834-4506-a230-42ddbfbc73c4",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "089d54fc-654e-4920-a1ce-6f932a86b44f",
"Asset": {
"AssetId": "96ba5fa6-5058-4c4c-a260-768444f96102",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "02142ac4-1f0d-4615-a4e0-494eda6612a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a44ec26-baf8-4d50-9f51-b964a99f1c03",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a9d82573-0926-4d96-a139-e5c86029014f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "95ae981f-8980-4cc2-86cd-cd4e56edb72b",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "0b98ba81-857a-4624-b86f-53564166d755",
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"StateType": {
"StateTypeId": "f243feb2-02f0-4dff-8c46-690cc2df26e9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "02142ac4-1f0d-4615-a4e0-494eda6612a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a44ec26-baf8-4d50-9f51-b964a99f1c03",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b57a1da2-1dc2-4f4f-88a1-652e5abbc0ec",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0faf3fb-ef98-414e-9089-c612b3388aa9",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b49cc100-a3ff-43f9-be53-56ccb8012e07",
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"StatusType": {
"StatusTypeId": "1e477745-1e27-45a9-a1ce-efa51f14e321",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "02142ac4-1f0d-4615-a4e0-494eda6612a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a44ec26-baf8-4d50-9f51-b964a99f1c03",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3cbd8aa1-6d0f-42f8-b7e5-09a21bdf430a",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3bf68467-f9a5-4a2f-aa3a-dfe40d0a3dc6",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "61653848-f987-478a-b130-c53a034d2e9d",
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "17c8a004-7671-426d-b84c-a376752ef908",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "32c72e2b-1234-4b42-a4fb-327f7d9882cf",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e7dbac99-9399-43b8-9f30-9fe298fb7733",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:40:32.5968944-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "72e6f535-f2d9-41f3-98c1-4b9ffac41485",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a9f685a6-075f-4838-9301-cdac4be39354",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f2d6c1e2-0dbe-4bc8-83a7-ea0d28441828",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-13T23:40:32.5968944-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "73131cc0-d834-4506-a230-42ddbfbc73c4",
"CreateDate": "2026-09-13T23:40:32.5968944-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:40:32.5968944-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}