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": "71018ec2-5e21-4c86-ae0e-5d1a546e1047",
"Asset": {
"AssetId": "83059279-485b-435f-9d66-8298c355dd6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8c4c5114-513a-46ec-9ba9-c00fd32823ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5be6168b-4e88-4947-b903-6097fe02aae4",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "026a9a31-3f1e-496d-ba53-9d23c9732ef5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"MeasurementValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2ca45758-b657-4c66-996c-2f7286920ed1",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ebe356be-b3a5-41ec-b705-5e29df2261e6",
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"StateType": {
"StateTypeId": "909df5e4-13da-43ac-9a60-80b0fbcdedff",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8c4c5114-513a-46ec-9ba9-c00fd32823ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5be6168b-4e88-4947-b903-6097fe02aae4",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2eb7964a-971e-428a-87b3-59d104ab297c",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f58d80bf-d9d6-4d90-b317-c909784c1203",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "df1e34d6-a1ca-4dc4-af93-6ada6e363461",
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"StatusType": {
"StatusTypeId": "c8ca816d-fcf1-4d23-b7cf-bd531cfad6d4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8c4c5114-513a-46ec-9ba9-c00fd32823ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5be6168b-4e88-4947-b903-6097fe02aae4",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b8f83ccb-276a-4992-a686-7b63834affdf",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f8dabce3-d323-4f3e-a9a1-ebd05b8c1cbb",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c6ab7eaa-7b46-4b9b-b57b-202fa21b9f18",
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "8a859cbd-4655-4096-8a0f-3f2d0db8edf0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "964a85bf-5676-46b1-9ceb-05bb93054990",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf9749f4-e5c7-4d47-8d74-b637ea418a40",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"MeasurementValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6d381a2a-6c95-485b-ba9e-052a401d0cfa",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3b4628a5-7937-4634-bb15-727a0951aa93",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4ee7558c-bf0b-49ed-9d40-b30c1c677c64",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a91a4a9c-6745-4596-a6eb-e58becd7bdaa",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "71018ec2-5e21-4c86-ae0e-5d1a546e1047",
"Asset": {
"AssetId": "83059279-485b-435f-9d66-8298c355dd6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8c4c5114-513a-46ec-9ba9-c00fd32823ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5be6168b-4e88-4947-b903-6097fe02aae4",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "026a9a31-3f1e-496d-ba53-9d23c9732ef5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"MeasurementValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2ca45758-b657-4c66-996c-2f7286920ed1",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ebe356be-b3a5-41ec-b705-5e29df2261e6",
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"StateType": {
"StateTypeId": "909df5e4-13da-43ac-9a60-80b0fbcdedff",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8c4c5114-513a-46ec-9ba9-c00fd32823ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5be6168b-4e88-4947-b903-6097fe02aae4",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2eb7964a-971e-428a-87b3-59d104ab297c",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f58d80bf-d9d6-4d90-b317-c909784c1203",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "df1e34d6-a1ca-4dc4-af93-6ada6e363461",
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"StatusType": {
"StatusTypeId": "c8ca816d-fcf1-4d23-b7cf-bd531cfad6d4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8c4c5114-513a-46ec-9ba9-c00fd32823ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5be6168b-4e88-4947-b903-6097fe02aae4",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b8f83ccb-276a-4992-a686-7b63834affdf",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f8dabce3-d323-4f3e-a9a1-ebd05b8c1cbb",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c6ab7eaa-7b46-4b9b-b57b-202fa21b9f18",
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "8a859cbd-4655-4096-8a0f-3f2d0db8edf0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "964a85bf-5676-46b1-9ceb-05bb93054990",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf9749f4-e5c7-4d47-8d74-b637ea418a40",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"MeasurementValueNeededDate": "2026-02-23T02:46:09.1470421-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6d381a2a-6c95-485b-ba9e-052a401d0cfa",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3b4628a5-7937-4634-bb15-727a0951aa93",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4ee7558c-bf0b-49ed-9d40-b30c1c677c64",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T02:46:09.1470421-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a91a4a9c-6745-4596-a6eb-e58becd7bdaa",
"CreateDate": "2026-02-23T02:46:09.1470421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T02:46:09.1470421-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}