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": "e7535bd7-deb0-4476-800a-5b2cf8daeea8",
"Asset": {
"AssetId": "bda2f9f4-2fe4-454d-8ac2-168e9b7b07de",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "14b88daf-f5ef-4270-a45b-918898c3d07a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6721e32e-6157-45a1-b963-c0f3b9d0efc6",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bc787607-b06c-4136-90c8-b235d6494920",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"MeasurementValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "612256eb-9276-47f6-9f4a-11e109436a22",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"MeasurementValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e749edce-1b27-4ada-9956-6d946e5f6eb0",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "59c876cb-fa85-4f0a-b485-95fbc36589f8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "39764ea4-4bac-438b-9d13-abd4aaef7cff",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-18T18:56:45.5515236-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fbc87753-918e-4bdb-8f8b-74afbb65332f",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "e7535bd7-deb0-4476-800a-5b2cf8daeea8",
"Asset": {
"AssetId": "bda2f9f4-2fe4-454d-8ac2-168e9b7b07de",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "14b88daf-f5ef-4270-a45b-918898c3d07a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6721e32e-6157-45a1-b963-c0f3b9d0efc6",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bc787607-b06c-4136-90c8-b235d6494920",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"MeasurementValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "612256eb-9276-47f6-9f4a-11e109436a22",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"MeasurementValueNeededDate": "2026-09-18T18:56:45.5515236-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e749edce-1b27-4ada-9956-6d946e5f6eb0",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "59c876cb-fa85-4f0a-b485-95fbc36589f8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "39764ea4-4bac-438b-9d13-abd4aaef7cff",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-18T18:56:45.5515236-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fbc87753-918e-4bdb-8f8b-74afbb65332f",
"CreateDate": "2026-09-18T18:56:45.5515236-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-18T18:56:45.5515236-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}