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": "05694fdf-8bcd-4eb9-a503-4b0afdc17e9e",
"Asset": {
"AssetId": "b6821b3f-4f4f-4eed-9734-892eabdd6cea",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "001e7ae1-eb91-432c-b310-fbb56a6238cd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e7abfc3d-8bed-471a-92c5-69a9346f8a5f",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bb069d69-2b75-41bd-b641-06d268203b1b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"MeasurementValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "998b00cf-2940-4413-b5fc-ac8cf2e7193b",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"MeasurementValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9b7cc0a8-547b-4c1f-97a7-2ce10e3b297f",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1b515062-da36-4551-9c96-bd940c239c12",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "990d38db-ac90-4d24-8d44-22935288c70e",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-05T09:15:36.4656682-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "27c764ea-2900-4350-a34b-4262344a9aa6",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "05694fdf-8bcd-4eb9-a503-4b0afdc17e9e",
"Asset": {
"AssetId": "b6821b3f-4f4f-4eed-9734-892eabdd6cea",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "001e7ae1-eb91-432c-b310-fbb56a6238cd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e7abfc3d-8bed-471a-92c5-69a9346f8a5f",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bb069d69-2b75-41bd-b641-06d268203b1b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"MeasurementValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "998b00cf-2940-4413-b5fc-ac8cf2e7193b",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"MeasurementValueNeededDate": "2025-07-05T09:15:36.4656682-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9b7cc0a8-547b-4c1f-97a7-2ce10e3b297f",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1b515062-da36-4551-9c96-bd940c239c12",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "990d38db-ac90-4d24-8d44-22935288c70e",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-05T09:15:36.4656682-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "27c764ea-2900-4350-a34b-4262344a9aa6",
"CreateDate": "2025-07-05T09:15:36.4656682-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-05T09:15:36.4656682-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}