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": "f6a2aeac-9ba8-49fd-8426-a4148318bd04",
"Asset": {
"AssetId": "dcac27ed-a227-40c2-ac9b-56851695ef16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a119b26b-cbec-4a02-9a72-e16aa2ce1f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c1919f08-ceae-4ee3-8bc8-66962f3dca27",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "36668a74-2277-4c50-9963-484b76e18703",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"MeasurementValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "057059af-46c4-4f79-80bd-c71598220bba",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"MeasurementValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fa0d415c-ce07-4c2e-b512-d07c0774a98c",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3dd761ca-7a43-4ad6-931e-e72b0a36db73",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "46262da9-55d4-421a-a3eb-6e5ab95926fa",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-13T21:06:12.7499629-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6af81438-4cdb-48ef-98f9-3baa286167e1",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "f6a2aeac-9ba8-49fd-8426-a4148318bd04",
"Asset": {
"AssetId": "dcac27ed-a227-40c2-ac9b-56851695ef16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a119b26b-cbec-4a02-9a72-e16aa2ce1f6a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c1919f08-ceae-4ee3-8bc8-66962f3dca27",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "36668a74-2277-4c50-9963-484b76e18703",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"MeasurementValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "057059af-46c4-4f79-80bd-c71598220bba",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"MeasurementValueNeededDate": "2025-09-13T21:06:12.7499629-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fa0d415c-ce07-4c2e-b512-d07c0774a98c",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3dd761ca-7a43-4ad6-931e-e72b0a36db73",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "46262da9-55d4-421a-a3eb-6e5ab95926fa",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-13T21:06:12.7499629-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6af81438-4cdb-48ef-98f9-3baa286167e1",
"CreateDate": "2025-09-13T21:06:12.7499629-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-13T21:06:12.7499629-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}