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": "2b9ec275-2e74-4d5a-85cc-08946af4998a",
"Asset": {
"AssetId": "229af405-68e8-4ce6-b79e-8fb29cda5d25",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "925a7a05-570f-4a2b-94da-23f3b05b622c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "426e7419-e47a-451f-9537-e1d46537b7b2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "aadce6e3-073b-443b-bd93-e3e571cabe02",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:15.9374943-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:15.9374943-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfeab1a9-4141-4269-b3fc-98f83f613339",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5d65a3bb-9a97-4ae6-8bb8-9cecb0c108b6",
"EffectiveDate": "2026-11-21T11:57:15.9374943-08:00",
"StateType": {
"StateTypeId": "6626f1e9-1a0a-4d60-a2ea-8fca7be0c43d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "925a7a05-570f-4a2b-94da-23f3b05b622c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "426e7419-e47a-451f-9537-e1d46537b7b2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d95fb439-0ef5-4c59-aa65-221091f014b3",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "38921f04-e885-4dff-8b82-6d87311865c1",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ad8aff08-1d89-48ee-832e-576e7b0ff48c",
"EffectiveDate": "2026-11-21T11:57:15.9374943-08:00",
"StatusType": {
"StatusTypeId": "b4fdf6cf-50a9-4f54-b795-b7cfa4853c75",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "925a7a05-570f-4a2b-94da-23f3b05b622c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "426e7419-e47a-451f-9537-e1d46537b7b2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "bcbc8a28-165d-40af-a95e-746cf5b446c2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5125fa06-bddb-425b-b28d-b2395c7566bd",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ad8cb69f-cc32-4668-b8e7-5e8f2eac877f",
"EffectiveDate": "2026-11-21T11:57:15.9531268-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b5b043a9-3774-4d85-b35e-851de0fb1f7e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b1950a50-6cce-4585-80e5-bd58168c8c97",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "61992660-1235-4b82-8f27-6eb3af9a2502",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:15.9531268-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:15.9531268-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7a5e4cdf-a8cb-402a-bae0-863d821def9e",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b00413a1-5400-49f7-b258-c0b73e9e144a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0500cad7-927e-49b3-9463-11ded9e049a4",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T11:57:15.9531268-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef797cce-9bbe-4606-b109-db1295f9913f",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "2b9ec275-2e74-4d5a-85cc-08946af4998a",
"Asset": {
"AssetId": "229af405-68e8-4ce6-b79e-8fb29cda5d25",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "925a7a05-570f-4a2b-94da-23f3b05b622c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "426e7419-e47a-451f-9537-e1d46537b7b2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "aadce6e3-073b-443b-bd93-e3e571cabe02",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:15.9374943-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:15.9374943-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfeab1a9-4141-4269-b3fc-98f83f613339",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5d65a3bb-9a97-4ae6-8bb8-9cecb0c108b6",
"EffectiveDate": "2026-11-21T11:57:15.9374943-08:00",
"StateType": {
"StateTypeId": "6626f1e9-1a0a-4d60-a2ea-8fca7be0c43d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "925a7a05-570f-4a2b-94da-23f3b05b622c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "426e7419-e47a-451f-9537-e1d46537b7b2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d95fb439-0ef5-4c59-aa65-221091f014b3",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "38921f04-e885-4dff-8b82-6d87311865c1",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ad8aff08-1d89-48ee-832e-576e7b0ff48c",
"EffectiveDate": "2026-11-21T11:57:15.9374943-08:00",
"StatusType": {
"StatusTypeId": "b4fdf6cf-50a9-4f54-b795-b7cfa4853c75",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "925a7a05-570f-4a2b-94da-23f3b05b622c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "426e7419-e47a-451f-9537-e1d46537b7b2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "bcbc8a28-165d-40af-a95e-746cf5b446c2",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5125fa06-bddb-425b-b28d-b2395c7566bd",
"CreateDate": "2026-11-21T11:57:15.9374943-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.9374943-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ad8cb69f-cc32-4668-b8e7-5e8f2eac877f",
"EffectiveDate": "2026-11-21T11:57:15.9531268-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b5b043a9-3774-4d85-b35e-851de0fb1f7e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b1950a50-6cce-4585-80e5-bd58168c8c97",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "61992660-1235-4b82-8f27-6eb3af9a2502",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:15.9531268-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:15.9531268-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7a5e4cdf-a8cb-402a-bae0-863d821def9e",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b00413a1-5400-49f7-b258-c0b73e9e144a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0500cad7-927e-49b3-9463-11ded9e049a4",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T11:57:15.9531268-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef797cce-9bbe-4606-b109-db1295f9913f",
"CreateDate": "2026-11-21T11:57:15.9531268-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.9531268-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}