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": "0f790d65-c0d6-4328-80e7-1c8fe020abb4",
"Asset": {
"AssetId": "19624993-769f-429d-b440-4c6e37d3977f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7425396b-afc7-4030-af5f-52c73f690e4a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e767209f-ad96-4f23-9a8b-0253408ff367",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "69aba208-eecb-49be-8bff-bdc604108586",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a3dcae05-8be0-45c5-90b5-cf4dd771c5e1",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db47313b-4e48-4122-8532-7ab58e7ab003",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "acfc046e-55d8-476f-b5c6-d8967e7ad122",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4d9f6288-55c7-42a4-85e6-2bed4d2e6de2",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-28T09:45:21.1810642-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a08c0409-94e4-4676-8bd7-cabfc1eef3a5",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "0f790d65-c0d6-4328-80e7-1c8fe020abb4",
"Asset": {
"AssetId": "19624993-769f-429d-b440-4c6e37d3977f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7425396b-afc7-4030-af5f-52c73f690e4a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e767209f-ad96-4f23-9a8b-0253408ff367",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "69aba208-eecb-49be-8bff-bdc604108586",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a3dcae05-8be0-45c5-90b5-cf4dd771c5e1",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:45:21.1810642-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db47313b-4e48-4122-8532-7ab58e7ab003",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "acfc046e-55d8-476f-b5c6-d8967e7ad122",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4d9f6288-55c7-42a4-85e6-2bed4d2e6de2",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-28T09:45:21.1810642-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a08c0409-94e4-4676-8bd7-cabfc1eef3a5",
"CreateDate": "2026-06-28T09:45:21.1810642-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:45:21.1810642-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}