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": "a0d777e8-0285-4674-a3f2-7b6b573e596b",
"Asset": {
"AssetId": "1cabff57-afe5-4fee-b835-f1aec9fdc91c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "124b5996-4c15-4ca5-8e87-7160a6c744a1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4dddbd53-1430-46d6-bc2c-14a903037149",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6309cb21-1c4e-4f0c-967f-0a4333d06558",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"MeasurementValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4a32a0e3-62ee-4587-87d1-37022e8a241f",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"MeasurementValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "995dc80e-f8fa-4922-926a-777aaa96393c",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "985c5b18-77fe-4265-a796-9f72fb872032",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f11273cc-cacf-4d51-89eb-8a9f6d1fa72a",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-16T02:01:30.963481-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6a055ace-7081-43fb-a0bd-53445e7d7b15",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "a0d777e8-0285-4674-a3f2-7b6b573e596b",
"Asset": {
"AssetId": "1cabff57-afe5-4fee-b835-f1aec9fdc91c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "124b5996-4c15-4ca5-8e87-7160a6c744a1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4dddbd53-1430-46d6-bc2c-14a903037149",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6309cb21-1c4e-4f0c-967f-0a4333d06558",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"MeasurementValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4a32a0e3-62ee-4587-87d1-37022e8a241f",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"MeasurementValueNeededDate": "2025-09-16T02:01:30.963481-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "995dc80e-f8fa-4922-926a-777aaa96393c",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "985c5b18-77fe-4265-a796-9f72fb872032",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f11273cc-cacf-4d51-89eb-8a9f6d1fa72a",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-16T02:01:30.963481-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6a055ace-7081-43fb-a0bd-53445e7d7b15",
"CreateDate": "2025-09-16T02:01:30.963481-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-16T02:01:30.963481-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}