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": "b60235ba-fc6c-4f7b-8132-f9db4b5ad927",
"Asset": {
"AssetId": "8ef9e9af-a52b-481c-a751-b2b73c04b6c3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "86caded2-4d8c-4360-8e1b-c12425c0a641",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "05449017-e1ab-41a9-8b96-3397f19e4c4f",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c69e1988-ad82-4a02-8b7f-fe773bba65c0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"MeasurementValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ccb34c82-9a75-4bab-952b-8acc54f79d32",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"MeasurementValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b899e053-2124-4260-8ee3-59642434e7c7",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3ee78139-3097-465a-806f-9ba432857125",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fd8f8ec0-ec4d-4809-bbdf-b6aab1872217",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-30T14:42:04.3420112-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "45b78a3b-621c-490e-863f-bedcede551d1",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "b60235ba-fc6c-4f7b-8132-f9db4b5ad927",
"Asset": {
"AssetId": "8ef9e9af-a52b-481c-a751-b2b73c04b6c3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "86caded2-4d8c-4360-8e1b-c12425c0a641",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "05449017-e1ab-41a9-8b96-3397f19e4c4f",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c69e1988-ad82-4a02-8b7f-fe773bba65c0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"MeasurementValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ccb34c82-9a75-4bab-952b-8acc54f79d32",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"MeasurementValueNeededDate": "2025-04-30T14:42:04.3420112-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b899e053-2124-4260-8ee3-59642434e7c7",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3ee78139-3097-465a-806f-9ba432857125",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fd8f8ec0-ec4d-4809-bbdf-b6aab1872217",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-30T14:42:04.3420112-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "45b78a3b-621c-490e-863f-bedcede551d1",
"CreateDate": "2025-04-30T14:42:04.3420112-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T14:42:04.3420112-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}