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": "85778d64-c8ec-429f-ad14-f8d924573e5e",
"Asset": {
"AssetId": "e4239661-1069-4ba9-8415-1abeabc356ca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e5913826-0459-4c20-9d7b-149acdff616f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b7c5ad20-671b-4539-ad8d-67c78bb5cda4",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3333de98-d2a6-4749-9158-bfb738ee535a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"MeasurementValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e822b6a2-00de-49b0-88ad-0cb13f6ac762",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"MeasurementValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d39db678-57cc-44b9-bd4d-8260221066f8",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8ccf825c-8363-449b-8875-eb2346e546d1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e73f8be0-4439-43b8-9b38-ec06a9d96d0b",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-13T14:05:36.447703-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "34dc73cc-bdad-477e-93b1-cdb0ccb84bd1",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "85778d64-c8ec-429f-ad14-f8d924573e5e",
"Asset": {
"AssetId": "e4239661-1069-4ba9-8415-1abeabc356ca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e5913826-0459-4c20-9d7b-149acdff616f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b7c5ad20-671b-4539-ad8d-67c78bb5cda4",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3333de98-d2a6-4749-9158-bfb738ee535a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"MeasurementValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e822b6a2-00de-49b0-88ad-0cb13f6ac762",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"MeasurementValueNeededDate": "2026-03-13T14:05:36.447703-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d39db678-57cc-44b9-bd4d-8260221066f8",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8ccf825c-8363-449b-8875-eb2346e546d1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e73f8be0-4439-43b8-9b38-ec06a9d96d0b",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-13T14:05:36.447703-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "34dc73cc-bdad-477e-93b1-cdb0ccb84bd1",
"CreateDate": "2026-03-13T14:05:36.447703-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T14:05:36.447703-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}