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": "c8bfd1d5-8fab-4057-900c-ab1bfc91609d",
"Asset": {
"AssetId": "95a1392c-aad9-4685-a9cb-88462e232a8f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9fa15948-7021-4b91-9e04-6f94eeabdf44",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08a8cb65-e574-4c73-b671-3f6296868703",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "34f58584-a164-4be7-8787-fcbd85b24c6f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"MeasurementValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4028dbd5-92f3-4a4c-97b4-c5dedb24a430",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"MeasurementValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3a5097e8-fad4-4196-aa4e-806838ad624a",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3c93630a-5e37-41bc-92f5-8884bb1ca45e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9fe73f79-70f3-4c89-826d-1d84b1a6648b",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-22T07:04:27.2043092-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b1e5e95c-e5c3-48f7-85fe-32c87a074b8f",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "c8bfd1d5-8fab-4057-900c-ab1bfc91609d",
"Asset": {
"AssetId": "95a1392c-aad9-4685-a9cb-88462e232a8f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9fa15948-7021-4b91-9e04-6f94eeabdf44",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08a8cb65-e574-4c73-b671-3f6296868703",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "34f58584-a164-4be7-8787-fcbd85b24c6f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"MeasurementValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4028dbd5-92f3-4a4c-97b4-c5dedb24a430",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"MeasurementValueNeededDate": "2025-12-22T07:04:27.2043092-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3a5097e8-fad4-4196-aa4e-806838ad624a",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3c93630a-5e37-41bc-92f5-8884bb1ca45e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9fe73f79-70f3-4c89-826d-1d84b1a6648b",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-22T07:04:27.2043092-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b1e5e95c-e5c3-48f7-85fe-32c87a074b8f",
"CreateDate": "2025-12-22T07:04:27.2043092-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-22T07:04:27.2043092-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}