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": "d0e39019-bb4e-4caa-a585-028fb2666d4e",
"Asset": {
"AssetId": "b0385993-04d0-4419-a9ca-6031194e9414",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "83910fca-e616-424f-b390-27ba16cf0afe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7c45cec1-b9ed-4a56-ad05-d29fecc8d51f",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4848c85a-5f62-4848-b25a-f0ab8d868046",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"MeasurementValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7bdb11ed-ac94-49f4-a818-81aabb87787d",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"MeasurementValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "75b9f040-1a09-4752-a2fe-4c5028ec89f6",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3ffba4c1-687f-41c8-8b1e-17af99adcf76",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a5a19627-107c-4abf-bdb6-a68fdb19d48b",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T10:27:33.2863878-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "08582376-dc11-4191-bbad-40ee412a7bd7",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "d0e39019-bb4e-4caa-a585-028fb2666d4e",
"Asset": {
"AssetId": "b0385993-04d0-4419-a9ca-6031194e9414",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "83910fca-e616-424f-b390-27ba16cf0afe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7c45cec1-b9ed-4a56-ad05-d29fecc8d51f",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4848c85a-5f62-4848-b25a-f0ab8d868046",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"MeasurementValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7bdb11ed-ac94-49f4-a818-81aabb87787d",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"MeasurementValueNeededDate": "2026-02-23T10:27:33.2863878-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "75b9f040-1a09-4752-a2fe-4c5028ec89f6",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3ffba4c1-687f-41c8-8b1e-17af99adcf76",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a5a19627-107c-4abf-bdb6-a68fdb19d48b",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T10:27:33.2863878-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "08582376-dc11-4191-bbad-40ee412a7bd7",
"CreateDate": "2026-02-23T10:27:33.2863878-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T10:27:33.2863878-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}