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": "5f636abd-9362-4e9e-b4d3-831d9b28c0d7",
"Asset": {
"AssetId": "974a4ab3-d861-4b46-88f0-5a8c26eec593",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "83c68d25-cf6c-419e-9ed8-aa5176e1ba1b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "af7d5529-0a20-4f92-99b8-3a263db0e3a5",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a542e844-fc48-4e2d-9d7d-c6573fa80110",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"MeasurementValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b4a69fbc-562a-42bf-be64-c40f5aea4ff1",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"MeasurementValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0132fd98-6d44-4161-98e6-23f3effc1854",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "aff329c2-bda6-4cbe-86a2-327acb30e519",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b6ae4ee6-3eb6-4d3d-8d35-e3314a4fa873",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T14:56:22.7991599-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ced8ae1a-cbe2-43b7-9093-e6c556af1248",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "5f636abd-9362-4e9e-b4d3-831d9b28c0d7",
"Asset": {
"AssetId": "974a4ab3-d861-4b46-88f0-5a8c26eec593",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "83c68d25-cf6c-419e-9ed8-aa5176e1ba1b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "af7d5529-0a20-4f92-99b8-3a263db0e3a5",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a542e844-fc48-4e2d-9d7d-c6573fa80110",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"MeasurementValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b4a69fbc-562a-42bf-be64-c40f5aea4ff1",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"MeasurementValueNeededDate": "2025-06-30T14:56:22.7991599-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0132fd98-6d44-4161-98e6-23f3effc1854",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "aff329c2-bda6-4cbe-86a2-327acb30e519",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b6ae4ee6-3eb6-4d3d-8d35-e3314a4fa873",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T14:56:22.7991599-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ced8ae1a-cbe2-43b7-9093-e6c556af1248",
"CreateDate": "2025-06-30T14:56:22.7991599-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T14:56:22.7991599-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}