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": "6109e7c6-bba4-4222-b84c-ac060feaa104",
"Asset": {
"AssetId": "36d4f9b2-2213-474d-b5c8-9e272ce9244a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "74d6fbf7-ed6c-4e5c-805b-a75c7eab7be7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "71395cac-7a45-4539-8b53-32a60cc4733f",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "03e60aae-1af2-4745-8c1c-2e80208724c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fd3a4d01-60d0-4d06-93a5-2e6ed174b836",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c0064df6-c2c1-4532-857d-76a305a37040",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "41110143-6e94-4e13-b13d-fa7b407f4823",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f227a143-b594-4432-adb5-56b0982f92c8",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-12T11:17:08.6108818-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c44a5fc5-4aa6-44b5-a097-8bbea5ba8853",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "6109e7c6-bba4-4222-b84c-ac060feaa104",
"Asset": {
"AssetId": "36d4f9b2-2213-474d-b5c8-9e272ce9244a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "74d6fbf7-ed6c-4e5c-805b-a75c7eab7be7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "71395cac-7a45-4539-8b53-32a60cc4733f",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "03e60aae-1af2-4745-8c1c-2e80208724c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fd3a4d01-60d0-4d06-93a5-2e6ed174b836",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:17:08.6108818-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c0064df6-c2c1-4532-857d-76a305a37040",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "41110143-6e94-4e13-b13d-fa7b407f4823",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f227a143-b594-4432-adb5-56b0982f92c8",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-12T11:17:08.6108818-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c44a5fc5-4aa6-44b5-a097-8bbea5ba8853",
"CreateDate": "2026-08-12T11:17:08.6108818-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:17:08.6108818-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}