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": "3336dd2d-f81d-47d8-b740-6f28e4178f87",
"Asset": {
"AssetId": "c63fe168-39c4-4984-bbee-7aa6177c349f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ada54ca3-789a-4482-9483-e6a08d80b862",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "de7ca4b1-74e6-4f52-b9c5-9c3c37997359",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "87ef18e0-2df8-43f6-824a-820d5cb6d9e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e78db901-b0b6-4952-997b-9e0e24bdd6c6",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "eef4076e-7c33-49d3-953e-745635612802",
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"StateType": {
"StateTypeId": "00cd009c-8c6b-4ec3-b438-d99284e45931",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ada54ca3-789a-4482-9483-e6a08d80b862",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "de7ca4b1-74e6-4f52-b9c5-9c3c37997359",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "eba7f42f-2f25-4120-86e6-c1a4bf3f3c8e",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5a1e2bc5-df40-4a4a-bee1-ef625f823a59",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c76987aa-6228-434f-a135-eccae4d17fea",
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"StatusType": {
"StatusTypeId": "4995b7a6-e6a4-4dc9-a642-1b627f61ffc3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ada54ca3-789a-4482-9483-e6a08d80b862",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "de7ca4b1-74e6-4f52-b9c5-9c3c37997359",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c0cb296b-ff23-4cec-ab06-6fbe7b1deeb3",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0cc9cb27-693c-4c66-9ae9-8f170855a97f",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d8048bbf-5c95-40ee-bdcb-3fb59fa26340",
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5127cd9c-696d-44de-a465-9ad1741d74e9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "94f31ac4-199c-4289-8156-5a2d954a5b45",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9fc6090b-eb8c-42cc-a262-15fe575284ae",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d9e8b6bb-d546-436c-94ce-b4ba20cdd740",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ba855779-4b70-4bf4-b03e-c22e4799d11b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8bfb2267-9913-4287-9641-f1fb28e6ac1e",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0015b629-13c2-47be-9d8b-293d997e0578",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "3336dd2d-f81d-47d8-b740-6f28e4178f87",
"Asset": {
"AssetId": "c63fe168-39c4-4984-bbee-7aa6177c349f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ada54ca3-789a-4482-9483-e6a08d80b862",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "de7ca4b1-74e6-4f52-b9c5-9c3c37997359",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "87ef18e0-2df8-43f6-824a-820d5cb6d9e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e78db901-b0b6-4952-997b-9e0e24bdd6c6",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "eef4076e-7c33-49d3-953e-745635612802",
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"StateType": {
"StateTypeId": "00cd009c-8c6b-4ec3-b438-d99284e45931",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ada54ca3-789a-4482-9483-e6a08d80b862",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "de7ca4b1-74e6-4f52-b9c5-9c3c37997359",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "eba7f42f-2f25-4120-86e6-c1a4bf3f3c8e",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5a1e2bc5-df40-4a4a-bee1-ef625f823a59",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c76987aa-6228-434f-a135-eccae4d17fea",
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"StatusType": {
"StatusTypeId": "4995b7a6-e6a4-4dc9-a642-1b627f61ffc3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ada54ca3-789a-4482-9483-e6a08d80b862",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "de7ca4b1-74e6-4f52-b9c5-9c3c37997359",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c0cb296b-ff23-4cec-ab06-6fbe7b1deeb3",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0cc9cb27-693c-4c66-9ae9-8f170855a97f",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d8048bbf-5c95-40ee-bdcb-3fb59fa26340",
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5127cd9c-696d-44de-a465-9ad1741d74e9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "94f31ac4-199c-4289-8156-5a2d954a5b45",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9fc6090b-eb8c-42cc-a262-15fe575284ae",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:08:09.857765-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d9e8b6bb-d546-436c-94ce-b4ba20cdd740",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ba855779-4b70-4bf4-b03e-c22e4799d11b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8bfb2267-9913-4287-9641-f1fb28e6ac1e",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-12T17:08:09.857765-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0015b629-13c2-47be-9d8b-293d997e0578",
"CreateDate": "2026-05-12T17:08:09.857765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:08:09.857765-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}