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": "2015f991-7e59-4000-95c1-f082e5359384",
"Asset": {
"AssetId": "84fba335-7239-4941-bf67-43b8bffc48ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "55f68586-cd68-4897-afa3-854182363ae2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "129df857-910d-4aa9-b375-19c9d92bc74a",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4765ba65-19ce-46c7-bcba-bf0c59856eda",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "32afc676-cee9-4f16-beab-db25cd38f2ed",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "164c4111-6cac-4cf2-b473-fd2d4ff238cc",
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"StateType": {
"StateTypeId": "38ec5173-d0cf-4b52-b807-681b766e9cca",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "55f68586-cd68-4897-afa3-854182363ae2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "129df857-910d-4aa9-b375-19c9d92bc74a",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "19a375de-8850-44c6-9f8d-835688ecbf3c",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "89e7d7af-3b8d-4377-9cc1-a97f913c267d",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fd975304-5d1e-4eea-9bf4-7acdd8e0fae6",
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"StatusType": {
"StatusTypeId": "5b117b9b-8c85-47bf-a6ab-cd60ee3f75e3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "55f68586-cd68-4897-afa3-854182363ae2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "129df857-910d-4aa9-b375-19c9d92bc74a",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b5473df4-024a-4156-a041-2c58ac8b83f5",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2a5e5ca9-848c-4ede-b396-48a20be33319",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a9377a3c-a98c-48af-89fe-5037dd0a6d43",
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2e405461-2fc9-42fd-8914-7fda46ed8f51",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d072c238-bec2-4efa-bf41-44a7ffece847",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e9a0490-3f57-42e3-9776-d529a94f2fe5",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9031ede6-2e7f-4747-b832-6287eba5acd4",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "bf74b3d4-90a5-4712-9ac5-f0f4d1c9eb4e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "05584380-1b67-482e-b16f-dc4432b7978e",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b6a59b97-af53-4193-a9ed-7a3d786abc2e",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "2015f991-7e59-4000-95c1-f082e5359384",
"Asset": {
"AssetId": "84fba335-7239-4941-bf67-43b8bffc48ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "55f68586-cd68-4897-afa3-854182363ae2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "129df857-910d-4aa9-b375-19c9d92bc74a",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4765ba65-19ce-46c7-bcba-bf0c59856eda",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "32afc676-cee9-4f16-beab-db25cd38f2ed",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "164c4111-6cac-4cf2-b473-fd2d4ff238cc",
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"StateType": {
"StateTypeId": "38ec5173-d0cf-4b52-b807-681b766e9cca",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "55f68586-cd68-4897-afa3-854182363ae2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "129df857-910d-4aa9-b375-19c9d92bc74a",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "19a375de-8850-44c6-9f8d-835688ecbf3c",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "89e7d7af-3b8d-4377-9cc1-a97f913c267d",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fd975304-5d1e-4eea-9bf4-7acdd8e0fae6",
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"StatusType": {
"StatusTypeId": "5b117b9b-8c85-47bf-a6ab-cd60ee3f75e3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "55f68586-cd68-4897-afa3-854182363ae2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "129df857-910d-4aa9-b375-19c9d92bc74a",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b5473df4-024a-4156-a041-2c58ac8b83f5",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2a5e5ca9-848c-4ede-b396-48a20be33319",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a9377a3c-a98c-48af-89fe-5037dd0a6d43",
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2e405461-2fc9-42fd-8914-7fda46ed8f51",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d072c238-bec2-4efa-bf41-44a7ffece847",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e9a0490-3f57-42e3-9776-d529a94f2fe5",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:57:50.0575346-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9031ede6-2e7f-4747-b832-6287eba5acd4",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "bf74b3d4-90a5-4712-9ac5-f0f4d1c9eb4e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "05584380-1b67-482e-b16f-dc4432b7978e",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-01T08:57:50.0575346-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b6a59b97-af53-4193-a9ed-7a3d786abc2e",
"CreateDate": "2026-11-01T08:57:50.0575346-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:57:50.0575346-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}