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": "06e82665-ff17-47da-81b6-cf0fac274d52",
"Asset": {
"AssetId": "2f701265-87dc-4126-a6c2-e2dd1b7587c3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3a3299b8-9f14-4ef3-8ae0-e6c6187a57c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "764956c8-3f83-4084-a8d4-b1c426ee0359",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0000548a-f965-4ce9-8d32-e454fbac23d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c7f6b069-c350-4aca-a3a6-facecd8dcf36",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3694af4b-0444-4668-b23a-0d5c9778bbfe",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "7dccf231-2129-4832-84c0-fc12bfd64f2c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "17a08786-5c11-4ab4-8da1-8a120cd9ac26",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-10T14:37:13.4020849-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d9d2a75d-9a6b-4961-b920-db09b173fd49",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "06e82665-ff17-47da-81b6-cf0fac274d52",
"Asset": {
"AssetId": "2f701265-87dc-4126-a6c2-e2dd1b7587c3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3a3299b8-9f14-4ef3-8ae0-e6c6187a57c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "764956c8-3f83-4084-a8d4-b1c426ee0359",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0000548a-f965-4ce9-8d32-e454fbac23d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c7f6b069-c350-4aca-a3a6-facecd8dcf36",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"MeasurementValueNeededDate": "2025-10-10T14:37:13.4020849-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3694af4b-0444-4668-b23a-0d5c9778bbfe",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "7dccf231-2129-4832-84c0-fc12bfd64f2c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "17a08786-5c11-4ab4-8da1-8a120cd9ac26",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-10T14:37:13.4020849-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d9d2a75d-9a6b-4961-b920-db09b173fd49",
"CreateDate": "2025-10-10T14:37:13.4020849-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-10T14:37:13.4020849-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}