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": "182cfc59-9764-4395-ace1-4cdade0f5e51",
"Asset": {
"AssetId": "68813094-d28c-4d93-82a0-04fd0d1002c5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b8bc4699-1e1b-4b20-afc1-48452a3ca6c9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4c666f6b-faec-4ce6-94fb-7066aa126d1e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b1127a50-1c53-441f-8879-4131ff34f35c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"MeasurementValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "180958c2-9b05-4497-8426-0028550bda2e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d1558940-77f4-4386-ac7b-438f8478c356",
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"StateType": {
"StateTypeId": "a690864a-c775-4c3b-8354-09fe2f1e94a7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b8bc4699-1e1b-4b20-afc1-48452a3ca6c9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4c666f6b-faec-4ce6-94fb-7066aa126d1e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "09ba3c0f-9f4d-487b-810d-267706f8cbaa",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fb119256-d159-4c0a-adb4-83253f763418",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6824fb34-b6ee-4811-a6f5-d4f6a859bda3",
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"StatusType": {
"StatusTypeId": "c49bdb50-5d49-4428-8618-5ab897fb3c13",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b8bc4699-1e1b-4b20-afc1-48452a3ca6c9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4c666f6b-faec-4ce6-94fb-7066aa126d1e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "482cbe47-a003-4b8a-b971-25b63e351e9a",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9801c459-36e5-4be2-90a5-1c2439757c63",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c3b741f7-7f46-4da3-bfe0-1abc2680dc0d",
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "37bd0615-10be-4001-ab5b-01e380c23080",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5f99487d-20ea-4728-afb2-181447b01a30",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "df6e8765-9705-4783-b5f9-c4bde84cff3b",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"MeasurementValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "71d8c925-fb22-49bf-8afb-5e5ec667d452",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8e8d3c9f-bb3c-4527-9377-131f2e3cf833",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7fd930c7-9508-4bdc-a9ca-a4a0990ea5d9",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "59c83895-208f-42fe-9492-39931cb4de65",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "182cfc59-9764-4395-ace1-4cdade0f5e51",
"Asset": {
"AssetId": "68813094-d28c-4d93-82a0-04fd0d1002c5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b8bc4699-1e1b-4b20-afc1-48452a3ca6c9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4c666f6b-faec-4ce6-94fb-7066aa126d1e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b1127a50-1c53-441f-8879-4131ff34f35c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"MeasurementValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "180958c2-9b05-4497-8426-0028550bda2e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d1558940-77f4-4386-ac7b-438f8478c356",
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"StateType": {
"StateTypeId": "a690864a-c775-4c3b-8354-09fe2f1e94a7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b8bc4699-1e1b-4b20-afc1-48452a3ca6c9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4c666f6b-faec-4ce6-94fb-7066aa126d1e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "09ba3c0f-9f4d-487b-810d-267706f8cbaa",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fb119256-d159-4c0a-adb4-83253f763418",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6824fb34-b6ee-4811-a6f5-d4f6a859bda3",
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"StatusType": {
"StatusTypeId": "c49bdb50-5d49-4428-8618-5ab897fb3c13",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b8bc4699-1e1b-4b20-afc1-48452a3ca6c9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4c666f6b-faec-4ce6-94fb-7066aa126d1e",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "482cbe47-a003-4b8a-b971-25b63e351e9a",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9801c459-36e5-4be2-90a5-1c2439757c63",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c3b741f7-7f46-4da3-bfe0-1abc2680dc0d",
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "37bd0615-10be-4001-ab5b-01e380c23080",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5f99487d-20ea-4728-afb2-181447b01a30",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "df6e8765-9705-4783-b5f9-c4bde84cff3b",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"MeasurementValueNeededDate": "2025-12-15T21:43:34.6321971-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "71d8c925-fb22-49bf-8afb-5e5ec667d452",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8e8d3c9f-bb3c-4527-9377-131f2e3cf833",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7fd930c7-9508-4bdc-a9ca-a4a0990ea5d9",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-15T21:43:34.6321971-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "59c83895-208f-42fe-9492-39931cb4de65",
"CreateDate": "2025-12-15T21:43:34.6321971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T21:43:34.6321971-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}