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": "d2a2e51c-7e21-4319-867d-dddef4cb68d7",
"Asset": {
"AssetId": "7c2496fd-f704-436d-a313-89bc521579cf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0d68dcee-d6a8-4aa1-8fd8-4a4e24858db3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1b5306d9-4bd6-489e-aed3-a09053473a0e",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "abe56e74-4d20-4928-b867-e2befbc4f3bc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"MeasurementValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3634abbd-2898-41f5-805c-09ed3c23b368",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"MeasurementValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "86752320-1d36-4b21-b576-512ee9b4b959",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1531d9f1-02c8-4518-9b0c-0f0640619f37",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "90ab1e45-85ec-4824-88bc-b3a7aa55c731",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T22:04:30.8124819-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "111163c6-cc54-442c-b04c-247f97741d61",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "d2a2e51c-7e21-4319-867d-dddef4cb68d7",
"Asset": {
"AssetId": "7c2496fd-f704-436d-a313-89bc521579cf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0d68dcee-d6a8-4aa1-8fd8-4a4e24858db3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1b5306d9-4bd6-489e-aed3-a09053473a0e",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "abe56e74-4d20-4928-b867-e2befbc4f3bc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"MeasurementValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3634abbd-2898-41f5-805c-09ed3c23b368",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"MeasurementValueNeededDate": "2025-09-17T22:04:30.8124819-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "86752320-1d36-4b21-b576-512ee9b4b959",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1531d9f1-02c8-4518-9b0c-0f0640619f37",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "90ab1e45-85ec-4824-88bc-b3a7aa55c731",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T22:04:30.8124819-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "111163c6-cc54-442c-b04c-247f97741d61",
"CreateDate": "2025-09-17T22:04:30.8124819-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T22:04:30.8124819-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}