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": "34ce6ea6-406b-40d7-90f2-fc0d8e88ec3d",
"Asset": {
"AssetId": "2fb6e6b1-fb13-4c9d-9da2-6d15c3c42860",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ca67141f-6a14-4b1a-8c60-58c601f9837d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6217a12f-766e-4f55-a65a-6928360da30f",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ad960dbd-bc40-40af-a080-faefa5ca2001",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "543ef243-c63d-430d-a92b-613654880f2b",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b0eafde0-7a8c-4c6d-a565-8078d36e15ca",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cd10a1c0-086a-45d9-bc79-c6bfc6ede309",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "28c1b892-b0e3-47be-810b-ded8d68af665",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-09T23:45:31.6043349-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cbdce505-bbf6-4735-8f13-a958c3dbd3fe",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "34ce6ea6-406b-40d7-90f2-fc0d8e88ec3d",
"Asset": {
"AssetId": "2fb6e6b1-fb13-4c9d-9da2-6d15c3c42860",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ca67141f-6a14-4b1a-8c60-58c601f9837d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6217a12f-766e-4f55-a65a-6928360da30f",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ad960dbd-bc40-40af-a080-faefa5ca2001",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "543ef243-c63d-430d-a92b-613654880f2b",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:45:31.6043349-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b0eafde0-7a8c-4c6d-a565-8078d36e15ca",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cd10a1c0-086a-45d9-bc79-c6bfc6ede309",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "28c1b892-b0e3-47be-810b-ded8d68af665",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-09T23:45:31.6043349-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cbdce505-bbf6-4735-8f13-a958c3dbd3fe",
"CreateDate": "2026-08-09T23:45:31.6043349-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:45:31.6043349-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}