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": "d679d142-4e6f-4c66-8c8b-237d899d03b1",
"Asset": {
"AssetId": "14d1f493-97e1-41ae-9528-a568e55f028e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "51b9a268-53d1-4c7c-abf5-22e47a7a98a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d59703e-d68b-44bf-97ad-59e40e05c87d",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9e36bedc-aee6-4fae-ac1b-109d5bc3247b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "70690987-bd83-4b31-a5c3-6905d82368fe",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8d274b5d-ff1a-44a8-bbe1-a11b4988a0e3",
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"StateType": {
"StateTypeId": "c5a0ef2a-161a-4ccd-aa0e-84aab975071c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "51b9a268-53d1-4c7c-abf5-22e47a7a98a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d59703e-d68b-44bf-97ad-59e40e05c87d",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7fa1b6e9-a584-4d03-9a56-02bfb909f20a",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c357a415-497f-431f-8189-a763b160e2bc",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "36f1e1b4-c483-47ca-a041-9e96799f4a48",
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"StatusType": {
"StatusTypeId": "b66d8e79-fec2-44a4-8b7f-a5891b1ecc41",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "51b9a268-53d1-4c7c-abf5-22e47a7a98a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d59703e-d68b-44bf-97ad-59e40e05c87d",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5f07673c-ed18-4e99-a0f4-5ec920e735e2",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1c4c4774-9cfa-4b33-b3cd-c9a63bea635e",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3f4fe148-be45-4d81-9529-863bcae9cf6f",
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "30a98b36-e8af-4ecf-ae23-71c30b1cee5a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e215dabb-87bb-4581-964b-345a38fc0316",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ba15bc49-f521-415e-9298-5e3c2452cf24",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e5e2970e-8897-4bd4-8daa-73b8e8f0e66a",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ed416bad-b3c4-440a-9dc7-affe1c58bd19",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f869c422-5bf0-40c3-b787-1aa244eab9f0",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c0edcb1b-ea66-4045-ad49-73fe45b80779",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "d679d142-4e6f-4c66-8c8b-237d899d03b1",
"Asset": {
"AssetId": "14d1f493-97e1-41ae-9528-a568e55f028e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "51b9a268-53d1-4c7c-abf5-22e47a7a98a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d59703e-d68b-44bf-97ad-59e40e05c87d",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9e36bedc-aee6-4fae-ac1b-109d5bc3247b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "70690987-bd83-4b31-a5c3-6905d82368fe",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8d274b5d-ff1a-44a8-bbe1-a11b4988a0e3",
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"StateType": {
"StateTypeId": "c5a0ef2a-161a-4ccd-aa0e-84aab975071c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "51b9a268-53d1-4c7c-abf5-22e47a7a98a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d59703e-d68b-44bf-97ad-59e40e05c87d",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7fa1b6e9-a584-4d03-9a56-02bfb909f20a",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c357a415-497f-431f-8189-a763b160e2bc",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "36f1e1b4-c483-47ca-a041-9e96799f4a48",
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"StatusType": {
"StatusTypeId": "b66d8e79-fec2-44a4-8b7f-a5891b1ecc41",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "51b9a268-53d1-4c7c-abf5-22e47a7a98a4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d59703e-d68b-44bf-97ad-59e40e05c87d",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5f07673c-ed18-4e99-a0f4-5ec920e735e2",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1c4c4774-9cfa-4b33-b3cd-c9a63bea635e",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3f4fe148-be45-4d81-9529-863bcae9cf6f",
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "30a98b36-e8af-4ecf-ae23-71c30b1cee5a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e215dabb-87bb-4581-964b-345a38fc0316",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ba15bc49-f521-415e-9298-5e3c2452cf24",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:41.9016995-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e5e2970e-8897-4bd4-8daa-73b8e8f0e66a",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ed416bad-b3c4-440a-9dc7-affe1c58bd19",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f869c422-5bf0-40c3-b787-1aa244eab9f0",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-01T20:27:41.9016995-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c0edcb1b-ea66-4045-ad49-73fe45b80779",
"CreateDate": "2026-06-01T20:27:41.9016995-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:41.9016995-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}