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": "83d8933f-a9c2-4f58-9ca7-091dcac0e035",
"Asset": {
"AssetId": "63ab67e5-2412-477b-a283-e7241c710449",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b1bfe445-d6a3-4787-8233-7bf60b10c572",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a1efa3a7-99d2-4602-bda3-cf409655ccdc",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4a66a33e-b4ba-44d2-a8cd-0522cb0ba934",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"MeasurementValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e7f264bf-d5dd-45ff-b22e-1b215e2a6b2e",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"MeasurementValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7509f002-4d13-4d3b-bcaf-b0eb26087e81",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "15cffa17-be89-4d3b-80a0-d52e53699676",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "96f49f04-a7ff-4a41-a469-a4d58c5debc3",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-26T23:23:16.265872-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "35c8bc86-b796-43d4-b63a-d2f8f6477289",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "83d8933f-a9c2-4f58-9ca7-091dcac0e035",
"Asset": {
"AssetId": "63ab67e5-2412-477b-a283-e7241c710449",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b1bfe445-d6a3-4787-8233-7bf60b10c572",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a1efa3a7-99d2-4602-bda3-cf409655ccdc",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4a66a33e-b4ba-44d2-a8cd-0522cb0ba934",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"MeasurementValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e7f264bf-d5dd-45ff-b22e-1b215e2a6b2e",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"MeasurementValueNeededDate": "2025-06-26T23:23:16.265872-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7509f002-4d13-4d3b-bcaf-b0eb26087e81",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "15cffa17-be89-4d3b-80a0-d52e53699676",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "96f49f04-a7ff-4a41-a469-a4d58c5debc3",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-26T23:23:16.265872-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "35c8bc86-b796-43d4-b63a-d2f8f6477289",
"CreateDate": "2025-06-26T23:23:16.265872-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-26T23:23:16.265872-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}