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": "ebec7478-544f-4fe1-9f83-bf9bac930c01",
"Asset": {
"AssetId": "3fb219d1-6440-4a7f-ad2a-59158678b2c7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ecce5775-70b6-4714-800d-694ea37ff21c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cef67260-2447-4803-a701-4b9866a7e44a",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d23ff8e9-1ae9-4ed9-b426-af21b69242b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3bef5d46-3cb8-49b3-890d-c9c5226ec386",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5a2dfa4f-02c9-4b22-ae41-c17898259c43",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e09936f6-8006-4b46-9267-b876bf98809d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3a19d7af-7645-4834-9496-d0b1d14e715d",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-21T19:34:52.7113104-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b38d5d73-1bba-4d56-b906-28d6db4f3e2d",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "ebec7478-544f-4fe1-9f83-bf9bac930c01",
"Asset": {
"AssetId": "3fb219d1-6440-4a7f-ad2a-59158678b2c7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ecce5775-70b6-4714-800d-694ea37ff21c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cef67260-2447-4803-a701-4b9866a7e44a",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d23ff8e9-1ae9-4ed9-b426-af21b69242b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3bef5d46-3cb8-49b3-890d-c9c5226ec386",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:34:52.7113104-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5a2dfa4f-02c9-4b22-ae41-c17898259c43",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e09936f6-8006-4b46-9267-b876bf98809d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3a19d7af-7645-4834-9496-d0b1d14e715d",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-21T19:34:52.7113104-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b38d5d73-1bba-4d56-b906-28d6db4f3e2d",
"CreateDate": "2024-12-21T19:34:52.7113104-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T19:34:52.7113104-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}