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": "f2438031-128f-4003-871c-7074692fc979",
"Asset": {
"AssetId": "b668e475-8a0d-4151-83e8-658bd1e89fe5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f92f8c6f-79e2-4a02-b9db-c022fcc60981",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4a838785-8bb4-4254-85d9-553971a33af0",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "eff4937d-e2fa-427c-9968-243ffa16dac7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"MeasurementValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "095bb9a2-329e-422f-b373-3d7461421cd1",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"MeasurementValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3935fca9-0565-41b7-aae1-b94e16779411",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "53bfe2cf-1f79-4daf-aea9-29bd67e2e66f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5f9b7e37-b732-42b3-bb7a-520b8a04265f",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-15T15:36:26.9837814-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6f881994-9375-44bb-bb5d-e6edf0332ad6",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "f2438031-128f-4003-871c-7074692fc979",
"Asset": {
"AssetId": "b668e475-8a0d-4151-83e8-658bd1e89fe5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f92f8c6f-79e2-4a02-b9db-c022fcc60981",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4a838785-8bb4-4254-85d9-553971a33af0",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "eff4937d-e2fa-427c-9968-243ffa16dac7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"MeasurementValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "095bb9a2-329e-422f-b373-3d7461421cd1",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"MeasurementValueNeededDate": "2026-08-15T15:36:26.9837814-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3935fca9-0565-41b7-aae1-b94e16779411",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "53bfe2cf-1f79-4daf-aea9-29bd67e2e66f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5f9b7e37-b732-42b3-bb7a-520b8a04265f",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-15T15:36:26.9837814-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6f881994-9375-44bb-bb5d-e6edf0332ad6",
"CreateDate": "2026-08-15T15:36:26.9837814-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-15T15:36:26.9837814-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}