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": "db4e9f0c-226e-4b07-b867-48ce1a9f4a82",
"Asset": {
"AssetId": "88b965b1-1a10-4c2a-a2e3-fa33faab9a25",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f65edae9-79c7-4471-854c-17546c22d3ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d008b2c-75bf-4087-aa93-f6fbd4476b08",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4509be34-b962-459e-8222-81d95294af08",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3a446dec-28b3-4243-ba2a-106a06ae6253",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e2c62d7e-f66d-48bd-91a5-6657bb1e43be",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "84646cc7-a1ad-4343-b6b8-e0e52aabf8c5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "75dbe740-6982-4dd2-b4c5-1b8f6a57b114",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-01T15:13:43.5414323-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "10f6f857-c047-473b-9635-4660e9c3e625",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "db4e9f0c-226e-4b07-b867-48ce1a9f4a82",
"Asset": {
"AssetId": "88b965b1-1a10-4c2a-a2e3-fa33faab9a25",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f65edae9-79c7-4471-854c-17546c22d3ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d008b2c-75bf-4087-aa93-f6fbd4476b08",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4509be34-b962-459e-8222-81d95294af08",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3a446dec-28b3-4243-ba2a-106a06ae6253",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:13:43.5414323-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e2c62d7e-f66d-48bd-91a5-6657bb1e43be",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "84646cc7-a1ad-4343-b6b8-e0e52aabf8c5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "75dbe740-6982-4dd2-b4c5-1b8f6a57b114",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-01T15:13:43.5414323-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "10f6f857-c047-473b-9635-4660e9c3e625",
"CreateDate": "2025-12-01T15:13:43.5414323-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:13:43.5414323-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}