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": "05b8d18b-55cd-41b2-963c-06ff3277e346",
"Asset": {
"AssetId": "14c43217-d382-4c2a-9088-79a1360ac113",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e6962184-336b-4417-9002-6337013ef670",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "061d5430-e7bf-490a-9817-de6b3e835a88",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4d6c288e-99a2-4f30-9464-f0556c33c248",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"MeasurementValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1f07d6b1-b718-4d41-b00e-dd382b884a98",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"MeasurementValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e10b2c9b-9f23-4a84-9dab-a9357e9eb7cb",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2e9af35d-4314-4f3f-bbae-cc146d357153",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4fe3f1e9-1dea-4947-9b7e-ceec6cc848f9",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-19T01:24:23.7715308-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c3e0b4dd-6085-4005-8182-ec532822682c",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "05b8d18b-55cd-41b2-963c-06ff3277e346",
"Asset": {
"AssetId": "14c43217-d382-4c2a-9088-79a1360ac113",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e6962184-336b-4417-9002-6337013ef670",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "061d5430-e7bf-490a-9817-de6b3e835a88",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4d6c288e-99a2-4f30-9464-f0556c33c248",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"MeasurementValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1f07d6b1-b718-4d41-b00e-dd382b884a98",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"MeasurementValueNeededDate": "2026-11-19T01:24:23.7715308-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e10b2c9b-9f23-4a84-9dab-a9357e9eb7cb",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2e9af35d-4314-4f3f-bbae-cc146d357153",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4fe3f1e9-1dea-4947-9b7e-ceec6cc848f9",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-19T01:24:23.7715308-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c3e0b4dd-6085-4005-8182-ec532822682c",
"CreateDate": "2026-11-19T01:24:23.7715308-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-19T01:24:23.7715308-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}