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": "7e52b132-84ff-49e6-a9d8-9eab872804e9",
"Asset": {
"AssetId": "89c15c52-271e-497d-8ede-441343cc529b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c59652b8-143c-4a2c-b317-a8a0524d7229",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ac446144-95dc-43ff-bed7-cae5681c4bbf",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "08fa9e3c-1edc-4a11-98a9-fbef270ae9b0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c66e070a-cd88-403c-9774-c30d48ef4228",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "35d7b0d6-7555-463a-a324-142422c08337",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f652892a-06be-4cd7-bea0-08ca658059df",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1dc068e7-88bb-43ce-afa1-471122f9e5ae",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-25T06:47:23.5633508-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3313b83-eca1-40c7-94b6-31a6f49335bc",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "7e52b132-84ff-49e6-a9d8-9eab872804e9",
"Asset": {
"AssetId": "89c15c52-271e-497d-8ede-441343cc529b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c59652b8-143c-4a2c-b317-a8a0524d7229",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ac446144-95dc-43ff-bed7-cae5681c4bbf",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "08fa9e3c-1edc-4a11-98a9-fbef270ae9b0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c66e070a-cd88-403c-9774-c30d48ef4228",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:47:23.5633508-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "35d7b0d6-7555-463a-a324-142422c08337",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f652892a-06be-4cd7-bea0-08ca658059df",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1dc068e7-88bb-43ce-afa1-471122f9e5ae",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-25T06:47:23.5633508-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3313b83-eca1-40c7-94b6-31a6f49335bc",
"CreateDate": "2025-06-25T06:47:23.5633508-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:47:23.5633508-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}