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": "0c12cd1d-a5bb-4fbd-8034-a6efef7b0d5f",
"Asset": {
"AssetId": "e5053be6-7af0-4dc7-b355-156e8fa602b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e971802e-1681-4c7f-824c-534374e76fce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ea90b77-6b3c-4c4e-90d2-1e315471ec21",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "175133b5-4ad7-4397-bf87-5be9b30614ff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5c5cb9ce-c0fb-4e52-b926-ff368fed7b48",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9e3cd4ce-62dc-4290-b0ac-5d01ec1b0011",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "defe5f2b-455f-4ca7-a956-5850785008a4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "95f8cb3c-f504-44bb-99e9-76581f0c998e",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-24T10:11:42.9630609-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e85799e3-95ea-43d2-a7c1-6185fa039532",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "0c12cd1d-a5bb-4fbd-8034-a6efef7b0d5f",
"Asset": {
"AssetId": "e5053be6-7af0-4dc7-b355-156e8fa602b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e971802e-1681-4c7f-824c-534374e76fce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ea90b77-6b3c-4c4e-90d2-1e315471ec21",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "175133b5-4ad7-4397-bf87-5be9b30614ff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5c5cb9ce-c0fb-4e52-b926-ff368fed7b48",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"MeasurementValueNeededDate": "2025-08-24T10:11:42.9630609-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9e3cd4ce-62dc-4290-b0ac-5d01ec1b0011",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "defe5f2b-455f-4ca7-a956-5850785008a4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "95f8cb3c-f504-44bb-99e9-76581f0c998e",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-24T10:11:42.9630609-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e85799e3-95ea-43d2-a7c1-6185fa039532",
"CreateDate": "2025-08-24T10:11:42.9630609-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-24T10:11:42.9630609-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}