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": "9070a559-9cb0-4acb-b68f-f9f7f7ccf023",
"Asset": {
"AssetId": "d7b35237-257e-427a-ad9b-f985f57826cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4bf8f432-b24e-4c96-bb95-453ee129cd0b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9adc1626-f60f-41ab-ba10-3bb3c31dab76",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "06e1c1c7-2e4d-4c32-884c-7d168b5c72f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6311c325-e89b-40d3-9ddb-cfc5c5fac4a2",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4daffe34-a67d-4a11-a63c-694c45ddb3bc",
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"StateType": {
"StateTypeId": "e30ae874-a7aa-419e-9969-a41c6e6a93cd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4bf8f432-b24e-4c96-bb95-453ee129cd0b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9adc1626-f60f-41ab-ba10-3bb3c31dab76",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ec7cb2b5-cb3f-466f-8d51-4639afb84a5d",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1b4de51e-426d-4842-9e87-e45b98dab8a6",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "21673c98-7a8d-46fc-8a1b-78eead15ce61",
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"StatusType": {
"StatusTypeId": "2a2b11e8-ead3-4459-9090-aee7f477955f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4bf8f432-b24e-4c96-bb95-453ee129cd0b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9adc1626-f60f-41ab-ba10-3bb3c31dab76",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "14d502b6-ef6a-4f98-bddd-a32fb2a23960",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9230b90c-9373-45cf-8188-86b77d4ab079",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fa1a1f75-0438-446e-b2be-72549146abce",
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "15654148-7512-442c-954f-f5a41bfaaccf",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d9e220a-0470-4d3c-b985-e5d5545c5771",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6df76c29-6ecd-4cfd-8f6b-8f80981701fa",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "01ee5cd4-8773-456b-b7f3-f9257aac418f",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3d5b1f8f-b394-42be-970b-93b166f424df",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "07f28ab9-bb1b-455b-bcfd-8acfb89181b7",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef947347-aef7-4b32-8174-29623e47a1ab",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "9070a559-9cb0-4acb-b68f-f9f7f7ccf023",
"Asset": {
"AssetId": "d7b35237-257e-427a-ad9b-f985f57826cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4bf8f432-b24e-4c96-bb95-453ee129cd0b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9adc1626-f60f-41ab-ba10-3bb3c31dab76",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "06e1c1c7-2e4d-4c32-884c-7d168b5c72f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6311c325-e89b-40d3-9ddb-cfc5c5fac4a2",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4daffe34-a67d-4a11-a63c-694c45ddb3bc",
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"StateType": {
"StateTypeId": "e30ae874-a7aa-419e-9969-a41c6e6a93cd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4bf8f432-b24e-4c96-bb95-453ee129cd0b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9adc1626-f60f-41ab-ba10-3bb3c31dab76",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ec7cb2b5-cb3f-466f-8d51-4639afb84a5d",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1b4de51e-426d-4842-9e87-e45b98dab8a6",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "21673c98-7a8d-46fc-8a1b-78eead15ce61",
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"StatusType": {
"StatusTypeId": "2a2b11e8-ead3-4459-9090-aee7f477955f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4bf8f432-b24e-4c96-bb95-453ee129cd0b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9adc1626-f60f-41ab-ba10-3bb3c31dab76",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "14d502b6-ef6a-4f98-bddd-a32fb2a23960",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9230b90c-9373-45cf-8188-86b77d4ab079",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fa1a1f75-0438-446e-b2be-72549146abce",
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "15654148-7512-442c-954f-f5a41bfaaccf",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d9e220a-0470-4d3c-b985-e5d5545c5771",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6df76c29-6ecd-4cfd-8f6b-8f80981701fa",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:32:39.7112633-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "01ee5cd4-8773-456b-b7f3-f9257aac418f",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3d5b1f8f-b394-42be-970b-93b166f424df",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "07f28ab9-bb1b-455b-bcfd-8acfb89181b7",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-17T17:32:39.7112633-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef947347-aef7-4b32-8174-29623e47a1ab",
"CreateDate": "2026-06-17T17:32:39.7112633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:32:39.7112633-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}