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": "919fa8b6-fda3-4e96-933c-6c60cac01178",
"Asset": {
"AssetId": "7713d6e9-7b29-4da5-8b3d-22c16b0b987b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1f8c436e-f216-49cd-adb2-3570a5a8625e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e36d8f1-8927-4601-8a66-3699ecce5b50",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c1de2499-20ed-49ea-91d5-f9eb29185819",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5ce2a6df-492d-4cde-bda9-0b0280cad259",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c2943c88-dbfa-409c-bb13-2f02fa1e6350",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "77e6239d-185f-414d-b61d-f18897401223",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "72ed06b5-8703-46a6-b35d-003f1440ddd9",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-05T06:21:12.962143-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f13b92dd-6d3f-4816-8dba-d6d6f41f7387",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "919fa8b6-fda3-4e96-933c-6c60cac01178",
"Asset": {
"AssetId": "7713d6e9-7b29-4da5-8b3d-22c16b0b987b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1f8c436e-f216-49cd-adb2-3570a5a8625e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e36d8f1-8927-4601-8a66-3699ecce5b50",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c1de2499-20ed-49ea-91d5-f9eb29185819",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5ce2a6df-492d-4cde-bda9-0b0280cad259",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"MeasurementValueNeededDate": "2025-12-05T06:21:12.962143-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c2943c88-dbfa-409c-bb13-2f02fa1e6350",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "77e6239d-185f-414d-b61d-f18897401223",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "72ed06b5-8703-46a6-b35d-003f1440ddd9",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-05T06:21:12.962143-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f13b92dd-6d3f-4816-8dba-d6d6f41f7387",
"CreateDate": "2025-12-05T06:21:12.962143-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-05T06:21:12.962143-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}