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": "cda1dc06-3d12-4079-8b77-179ec74b53e1",
"Asset": {
"AssetId": "227eaffe-3125-4734-9e6c-212d68cab1e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a33a88dd-050f-43fa-b70a-aee83fc7a8f3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bbe3ecb9-2bd2-48ac-a885-d25cfa7073e5",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "aecdb72f-f0ec-4b47-b4af-ccd1ddc863e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"MeasurementValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bed71f49-5509-442b-9a5b-700039fd3165",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"MeasurementValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fe3a81d7-9d97-4421-82ad-74aefcd8d9a2",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2a900449-26d8-4dc0-a673-e968b18682a6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "93d1b753-7ac1-4569-b0af-ea074611a514",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-08T14:03:52.588915-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1a396581-54b5-4d92-98ea-43b1d39919eb",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "cda1dc06-3d12-4079-8b77-179ec74b53e1",
"Asset": {
"AssetId": "227eaffe-3125-4734-9e6c-212d68cab1e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a33a88dd-050f-43fa-b70a-aee83fc7a8f3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bbe3ecb9-2bd2-48ac-a885-d25cfa7073e5",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "aecdb72f-f0ec-4b47-b4af-ccd1ddc863e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"MeasurementValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bed71f49-5509-442b-9a5b-700039fd3165",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"MeasurementValueNeededDate": "2024-12-08T14:03:52.588915-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fe3a81d7-9d97-4421-82ad-74aefcd8d9a2",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2a900449-26d8-4dc0-a673-e968b18682a6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "93d1b753-7ac1-4569-b0af-ea074611a514",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-08T14:03:52.588915-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1a396581-54b5-4d92-98ea-43b1d39919eb",
"CreateDate": "2024-12-08T14:03:52.588915-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-08T14:03:52.588915-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}