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": "b3fe9672-439d-43d3-9c5d-853b2cba6c34",
"Asset": {
"AssetId": "9942c324-3bf0-4e57-8370-22e30f6f5fcb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2df3d742-ecfa-4d06-bf4e-7bca98da5543",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "364b9551-d85d-4a42-95d0-4818899c8336",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "89841391-28ae-4a82-99e5-878865959208",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e7ae40e2-fed1-4a7f-ae0a-1660bdd1e647",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "67302c38-3128-42a1-ac5f-c26eece6d6ae",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1168f123-1185-480e-a97b-df64c2673f59",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ab5c8ffa-78c9-4bc3-ad2f-a65497d6e09a",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T03:19:21.3729755-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7996173f-6c78-4103-be07-5b141421afe5",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "b3fe9672-439d-43d3-9c5d-853b2cba6c34",
"Asset": {
"AssetId": "9942c324-3bf0-4e57-8370-22e30f6f5fcb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2df3d742-ecfa-4d06-bf4e-7bca98da5543",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "364b9551-d85d-4a42-95d0-4818899c8336",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "89841391-28ae-4a82-99e5-878865959208",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e7ae40e2-fed1-4a7f-ae0a-1660bdd1e647",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:19:21.3729755-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "67302c38-3128-42a1-ac5f-c26eece6d6ae",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1168f123-1185-480e-a97b-df64c2673f59",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ab5c8ffa-78c9-4bc3-ad2f-a65497d6e09a",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T03:19:21.3729755-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7996173f-6c78-4103-be07-5b141421afe5",
"CreateDate": "2025-07-31T03:19:21.3729755-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:19:21.3729755-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}