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": "06d9e777-e6f1-4fe3-8931-1e828318f6b7",
"Asset": {
"AssetId": "853ffba6-5302-4b7f-b67c-a24368ce37be",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2824ab99-ad23-4f76-a97f-d7fb3c9feff0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e46275fe-845c-4cc8-bf4e-a9ba150bfae8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ffd79cc2-452e-4d9b-b29a-7719fee82581",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0716c854-600b-4828-88b0-bfec1759faa5",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f1f4514e-5398-4580-b8b1-56419785988f",
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"StateType": {
"StateTypeId": "066f873c-a650-4d4d-a734-f4a028742d70",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2824ab99-ad23-4f76-a97f-d7fb3c9feff0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e46275fe-845c-4cc8-bf4e-a9ba150bfae8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "60eb7d8e-4417-4b3c-8f2b-a09962d4a097",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "19dea83e-3d22-4b8f-a5c0-bcf15f4b1d7b",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dc7c8a93-72c1-4f76-9273-1347f56b2820",
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"StatusType": {
"StatusTypeId": "7a80c059-464b-4912-97e8-37fe0aec357d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2824ab99-ad23-4f76-a97f-d7fb3c9feff0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e46275fe-845c-4cc8-bf4e-a9ba150bfae8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e123a96c-07d0-4730-b2ce-b01b0df8015e",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "05bbf36a-8685-4dd5-b003-5a91fbc70c5f",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e983fb24-bacd-4130-8028-054c55ea5029",
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "500142ed-f8ef-4d3d-8861-f6858c9f5a7b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0d42111a-e6ba-4c40-a1a4-7196d73f144b",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1e6bf259-1e5f-4bcb-8514-743cca4858b8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f9699415-5c16-45bf-9797-29c4cc8fa659",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2da009d6-f6a1-4da6-9a0d-903ab42e4be4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "276f2498-b58c-4012-a6d9-e755c7361349",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c8c4911-b8eb-41d0-b8b4-23ff517fd975",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "06d9e777-e6f1-4fe3-8931-1e828318f6b7",
"Asset": {
"AssetId": "853ffba6-5302-4b7f-b67c-a24368ce37be",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2824ab99-ad23-4f76-a97f-d7fb3c9feff0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e46275fe-845c-4cc8-bf4e-a9ba150bfae8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ffd79cc2-452e-4d9b-b29a-7719fee82581",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0716c854-600b-4828-88b0-bfec1759faa5",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f1f4514e-5398-4580-b8b1-56419785988f",
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"StateType": {
"StateTypeId": "066f873c-a650-4d4d-a734-f4a028742d70",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2824ab99-ad23-4f76-a97f-d7fb3c9feff0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e46275fe-845c-4cc8-bf4e-a9ba150bfae8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "60eb7d8e-4417-4b3c-8f2b-a09962d4a097",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "19dea83e-3d22-4b8f-a5c0-bcf15f4b1d7b",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dc7c8a93-72c1-4f76-9273-1347f56b2820",
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"StatusType": {
"StatusTypeId": "7a80c059-464b-4912-97e8-37fe0aec357d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2824ab99-ad23-4f76-a97f-d7fb3c9feff0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e46275fe-845c-4cc8-bf4e-a9ba150bfae8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e123a96c-07d0-4730-b2ce-b01b0df8015e",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "05bbf36a-8685-4dd5-b003-5a91fbc70c5f",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e983fb24-bacd-4130-8028-054c55ea5029",
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "500142ed-f8ef-4d3d-8861-f6858c9f5a7b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0d42111a-e6ba-4c40-a1a4-7196d73f144b",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1e6bf259-1e5f-4bcb-8514-743cca4858b8",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:23:08.9517372-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f9699415-5c16-45bf-9797-29c4cc8fa659",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2da009d6-f6a1-4da6-9a0d-903ab42e4be4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "276f2498-b58c-4012-a6d9-e755c7361349",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-15T13:23:08.9517372-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6c8c4911-b8eb-41d0-b8b4-23ff517fd975",
"CreateDate": "2026-07-15T13:23:08.9517372-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:08.9517372-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}