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": "440ff63a-fd89-4d19-9d9a-53d840fa91a2",
"Asset": {
"AssetId": "7e578470-0f7a-49ee-bdae-469889ac201f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "18fde56b-496d-45cf-8f6c-46d11524b051",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6c665ab4-9801-4417-8d45-f7eaff8f9e69",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "05bdd607-d205-46ab-bcce-cdffca9431ae",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"MeasurementValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "921d591b-ba19-41ed-97e1-4f16294edf9c",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"MeasurementValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e4c8a3ea-fdaa-4db6-a63d-62bf5a45b1ba",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "19af7576-16a9-4488-acc2-ddc7abe0099e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7ad8cc8e-982d-48af-9ade-89ff650058a3",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-14T03:03:44.2798438-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0665cf05-b02e-400f-8977-2686a6b9682b",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "440ff63a-fd89-4d19-9d9a-53d840fa91a2",
"Asset": {
"AssetId": "7e578470-0f7a-49ee-bdae-469889ac201f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "18fde56b-496d-45cf-8f6c-46d11524b051",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6c665ab4-9801-4417-8d45-f7eaff8f9e69",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "05bdd607-d205-46ab-bcce-cdffca9431ae",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"MeasurementValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "921d591b-ba19-41ed-97e1-4f16294edf9c",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"MeasurementValueNeededDate": "2025-12-14T03:03:44.2798438-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e4c8a3ea-fdaa-4db6-a63d-62bf5a45b1ba",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "19af7576-16a9-4488-acc2-ddc7abe0099e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7ad8cc8e-982d-48af-9ade-89ff650058a3",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-14T03:03:44.2798438-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0665cf05-b02e-400f-8977-2686a6b9682b",
"CreateDate": "2025-12-14T03:03:44.2798438-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-14T03:03:44.2798438-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}