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": "f6ac53ad-c69a-43a9-a1dd-c9e978ec1305",
"Asset": {
"AssetId": "581bafc8-797f-4483-9a49-d12da2e9befb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "03691ad7-1fcc-4ae8-bab7-0cb645663dc7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a10c3230-ec56-46ff-b1ba-40c7990d90e8",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e45e2acd-24e1-40fd-a21a-da1b1f5d797f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9596d206-9a82-4a1b-9789-70cecdace6a3",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9de7c684-cfbb-44a8-9cdc-c7401081f14c",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1a6d5ec2-045e-4e53-8480-0c5eb6ce8c66",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "35950d3c-81e1-4cc6-a8e2-6e8ee40005e7",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-23T22:43:59.2212666-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4fd9f45f-5f80-4a7e-9a45-00aa5f9edc0d",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "f6ac53ad-c69a-43a9-a1dd-c9e978ec1305",
"Asset": {
"AssetId": "581bafc8-797f-4483-9a49-d12da2e9befb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "03691ad7-1fcc-4ae8-bab7-0cb645663dc7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a10c3230-ec56-46ff-b1ba-40c7990d90e8",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e45e2acd-24e1-40fd-a21a-da1b1f5d797f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9596d206-9a82-4a1b-9789-70cecdace6a3",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:43:59.2212666-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9de7c684-cfbb-44a8-9cdc-c7401081f14c",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1a6d5ec2-045e-4e53-8480-0c5eb6ce8c66",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "35950d3c-81e1-4cc6-a8e2-6e8ee40005e7",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-23T22:43:59.2212666-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4fd9f45f-5f80-4a7e-9a45-00aa5f9edc0d",
"CreateDate": "2025-08-23T22:43:59.2212666-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:43:59.2212666-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}