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": "19f87ec9-940f-4de2-b915-410c72374fe5",
"Asset": {
"AssetId": "783f7d0e-f6e3-4d2e-8a1c-5e8fdb690b82",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d1f2b142-1d85-4ce3-ae13-83acc72c7fba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6c9cc690-44b8-4de4-9ff2-9d9268555abe",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8af5c946-a35c-49b0-a9d2-5129326311d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ec8e56b-c1b1-4413-ac91-07723f2e9dff",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "adc69286-8804-4332-9d68-bcc8c4c0d4df",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "feeab136-7f74-4a2e-9fbb-cbadab50ae35",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "33f325aa-cecf-4a05-85ea-22cc305f4298",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-14T00:00:50.1533479-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "317edd2c-956b-4489-a6a5-3d98c1e0bc4c",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "19f87ec9-940f-4de2-b915-410c72374fe5",
"Asset": {
"AssetId": "783f7d0e-f6e3-4d2e-8a1c-5e8fdb690b82",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d1f2b142-1d85-4ce3-ae13-83acc72c7fba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6c9cc690-44b8-4de4-9ff2-9d9268555abe",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8af5c946-a35c-49b0-a9d2-5129326311d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ec8e56b-c1b1-4413-ac91-07723f2e9dff",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:00:50.1533479-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "adc69286-8804-4332-9d68-bcc8c4c0d4df",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "feeab136-7f74-4a2e-9fbb-cbadab50ae35",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "33f325aa-cecf-4a05-85ea-22cc305f4298",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-14T00:00:50.1533479-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "317edd2c-956b-4489-a6a5-3d98c1e0bc4c",
"CreateDate": "2026-07-14T00:00:50.1533479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-14T00:00:50.1533479-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}