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": "5bf2b240-bf8e-4378-a111-f9358d0158c6",
"Asset": {
"AssetId": "d606f6a9-83f2-4602-80f6-a1d8bae1bcbc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7b34e0a9-4541-4b16-979f-0d6541c58272",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "471886a9-0716-4559-9a3b-a18765799355",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7e4d583d-47e7-472c-b80b-2555ca214f72",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"MeasurementValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "19f73834-1835-41f4-8a7b-36f58208637f",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"MeasurementValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17c22d2c-8d61-4f75-b7aa-f95000324be6",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f54dfb99-f341-4dc0-aabe-59eb5aa633b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d1b5ef83-ef6f-45ab-b536-b3d3bb523eba",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-27T23:48:09.5669784-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e4b53466-73f7-4956-b3e8-52ecc0115940",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "5bf2b240-bf8e-4378-a111-f9358d0158c6",
"Asset": {
"AssetId": "d606f6a9-83f2-4602-80f6-a1d8bae1bcbc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7b34e0a9-4541-4b16-979f-0d6541c58272",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "471886a9-0716-4559-9a3b-a18765799355",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7e4d583d-47e7-472c-b80b-2555ca214f72",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"MeasurementValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "19f73834-1835-41f4-8a7b-36f58208637f",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"MeasurementValueNeededDate": "2026-10-27T23:48:09.5669784-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17c22d2c-8d61-4f75-b7aa-f95000324be6",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f54dfb99-f341-4dc0-aabe-59eb5aa633b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d1b5ef83-ef6f-45ab-b536-b3d3bb523eba",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-27T23:48:09.5669784-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e4b53466-73f7-4956-b3e8-52ecc0115940",
"CreateDate": "2026-10-27T23:48:09.5669784-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-27T23:48:09.5669784-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}