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": "c2e89a5a-8050-428d-9557-4f459a5d5c38",
"Asset": {
"AssetId": "d7e5de80-98b2-47a1-833f-6e069d433270",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4d36cd9e-70f0-4c43-bb4d-12992790f320",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b0fbafca-7d7d-432c-a8cc-8e3b6518e172",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "dc8fe7aa-923d-4b3f-8b45-d61ed5e8474d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"MeasurementValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "86d9282a-bacb-4b46-bb70-ae2f724b743b",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"MeasurementValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "92c0aaa8-a634-4360-b049-3b1cdf90c060",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "83cf82de-5714-4518-b127-0c9165f810dd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1544f11e-bd3e-440b-8bab-0c102779be73",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-10T05:00:48.8235339-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f9debb1b-33db-408e-866a-8eb7ff71bd96",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "c2e89a5a-8050-428d-9557-4f459a5d5c38",
"Asset": {
"AssetId": "d7e5de80-98b2-47a1-833f-6e069d433270",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4d36cd9e-70f0-4c43-bb4d-12992790f320",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b0fbafca-7d7d-432c-a8cc-8e3b6518e172",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "dc8fe7aa-923d-4b3f-8b45-d61ed5e8474d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"MeasurementValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "86d9282a-bacb-4b46-bb70-ae2f724b743b",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"MeasurementValueNeededDate": "2025-12-10T05:00:48.8235339-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "92c0aaa8-a634-4360-b049-3b1cdf90c060",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "83cf82de-5714-4518-b127-0c9165f810dd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1544f11e-bd3e-440b-8bab-0c102779be73",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-10T05:00:48.8235339-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f9debb1b-33db-408e-866a-8eb7ff71bd96",
"CreateDate": "2025-12-10T05:00:48.8235339-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-10T05:00:48.8235339-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}