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": "6ecaf309-e367-4b6e-82d0-c7a59698db73",
"Asset": {
"AssetId": "23c8eace-bd55-44da-a97d-54868c80d8fc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1e820661-be4e-4e91-a6ca-c7f9c8c8f675",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4c6a7b69-fa26-417a-8e5a-c873c7e4135d",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a7c09413-2b9f-47cb-90a5-84cd971f7723",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"MeasurementValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "09e30249-6817-44c5-b31a-495c1cc5df97",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"MeasurementValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af2f123d-eb3d-4c21-85ac-13d7cf95cc45",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0ca5038d-5619-40ef-9a63-e19cff6dd6f3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2a540667-f79b-4917-91d7-d5115794d29f",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-19T09:50:04.9292705-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3ef1b194-fcc5-4288-a7f6-e36b72b0d987",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "6ecaf309-e367-4b6e-82d0-c7a59698db73",
"Asset": {
"AssetId": "23c8eace-bd55-44da-a97d-54868c80d8fc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1e820661-be4e-4e91-a6ca-c7f9c8c8f675",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4c6a7b69-fa26-417a-8e5a-c873c7e4135d",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a7c09413-2b9f-47cb-90a5-84cd971f7723",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"MeasurementValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "09e30249-6817-44c5-b31a-495c1cc5df97",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"MeasurementValueNeededDate": "2026-01-19T09:50:04.9292705-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af2f123d-eb3d-4c21-85ac-13d7cf95cc45",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0ca5038d-5619-40ef-9a63-e19cff6dd6f3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2a540667-f79b-4917-91d7-d5115794d29f",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-19T09:50:04.9292705-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3ef1b194-fcc5-4288-a7f6-e36b72b0d987",
"CreateDate": "2026-01-19T09:50:04.9292705-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T09:50:04.9292705-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}