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": "a383623c-85af-4db0-a925-f8c5cd6d2139",
"Asset": {
"AssetId": "3979f904-98af-4d63-96d0-892f35e330f7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "251e442a-6957-4b07-a1b0-59b522634b93",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aba2957-3c37-4688-a349-f67d603c5f5e",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cf0a676e-9746-4fbc-b416-b346e6f5a4fb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"MeasurementValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8c03bf08-d8ba-4683-80b6-9aa60e1d9129",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fca6da81-cdd5-4ccb-b706-ee6219df1370",
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"StateType": {
"StateTypeId": "ff5853d1-c25b-405e-87df-9efe4a46744d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "251e442a-6957-4b07-a1b0-59b522634b93",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aba2957-3c37-4688-a349-f67d603c5f5e",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6d157d94-57c7-4268-93e7-eb1fab0ef9d9",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0d96b121-cf8b-4d60-a447-1998e87631ed",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ab0242e6-9db6-4599-a1ed-b4646fce6b64",
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"StatusType": {
"StatusTypeId": "392afcb8-d962-4fee-a72c-7e9392a69ccf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "251e442a-6957-4b07-a1b0-59b522634b93",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aba2957-3c37-4688-a349-f67d603c5f5e",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fd5b3166-4c10-402c-9b66-c1e6b9d1bcbb",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "42c941ab-be00-4c8f-a2fa-b034feb6aa8c",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2ccbb2fe-7ac0-4aa6-bb2e-8ad5f5039a18",
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "cc94123f-6fc9-4e5f-ab74-7c973803c740",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ecc125f-5ec2-4704-868f-c9fe25036560",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b5536309-43ca-40f6-8ec7-5448c7c34738",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"MeasurementValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fbc3752f-efd7-4234-9ae8-4c4dfe3db821",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5c699527-1455-4d3d-86fe-6075262ee87f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0eb1cc8d-c2c9-4c48-bb5f-6202b064b21d",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86541b40-f7b9-4303-8bfc-1d86d91e3c8a",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 6"
},
{
"NoteId": "a383623c-85af-4db0-a925-f8c5cd6d2139",
"Asset": {
"AssetId": "3979f904-98af-4d63-96d0-892f35e330f7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "251e442a-6957-4b07-a1b0-59b522634b93",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aba2957-3c37-4688-a349-f67d603c5f5e",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cf0a676e-9746-4fbc-b416-b346e6f5a4fb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"MeasurementValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8c03bf08-d8ba-4683-80b6-9aa60e1d9129",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fca6da81-cdd5-4ccb-b706-ee6219df1370",
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"StateType": {
"StateTypeId": "ff5853d1-c25b-405e-87df-9efe4a46744d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "251e442a-6957-4b07-a1b0-59b522634b93",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aba2957-3c37-4688-a349-f67d603c5f5e",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6d157d94-57c7-4268-93e7-eb1fab0ef9d9",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0d96b121-cf8b-4d60-a447-1998e87631ed",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ab0242e6-9db6-4599-a1ed-b4646fce6b64",
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"StatusType": {
"StatusTypeId": "392afcb8-d962-4fee-a72c-7e9392a69ccf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "251e442a-6957-4b07-a1b0-59b522634b93",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aba2957-3c37-4688-a349-f67d603c5f5e",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fd5b3166-4c10-402c-9b66-c1e6b9d1bcbb",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "42c941ab-be00-4c8f-a2fa-b034feb6aa8c",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2ccbb2fe-7ac0-4aa6-bb2e-8ad5f5039a18",
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "cc94123f-6fc9-4e5f-ab74-7c973803c740",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ecc125f-5ec2-4704-868f-c9fe25036560",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b5536309-43ca-40f6-8ec7-5448c7c34738",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"MeasurementValueNeededDate": "2026-10-03T15:11:09.221894-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fbc3752f-efd7-4234-9ae8-4c4dfe3db821",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5c699527-1455-4d3d-86fe-6075262ee87f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0eb1cc8d-c2c9-4c48-bb5f-6202b064b21d",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-03T15:11:09.221894-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86541b40-f7b9-4303-8bfc-1d86d91e3c8a",
"CreateDate": "2026-10-03T15:11:09.221894-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-03T15:11:09.221894-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}