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": "96f3fcac-26ed-4a96-bf1b-a2f6d66138b5",
"Asset": {
"AssetId": "93de8384-6867-4b33-997f-44bb869aaee6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1cd33a9b-8a08-49c7-abf5-4e8ea626d004",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "22c59e82-bb0e-4c45-8a11-18c3edd80ada",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "16acbd7b-fb82-4007-a038-7c1aa8a9af53",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03feec4a-409f-4eab-80dc-5af9e31629f2",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db3285e0-fa7e-43b4-a252-2ed9654e61ee",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "984243f8-dec5-4c2b-ae4d-eb04c7cdd01a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2f604d2d-4348-4307-9051-f55cabcae4a8",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-03T02:31:09.4077076-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "07ddb45d-0479-43bf-9e21-c3b86167cb99",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "96f3fcac-26ed-4a96-bf1b-a2f6d66138b5",
"Asset": {
"AssetId": "93de8384-6867-4b33-997f-44bb869aaee6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1cd33a9b-8a08-49c7-abf5-4e8ea626d004",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "22c59e82-bb0e-4c45-8a11-18c3edd80ada",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "16acbd7b-fb82-4007-a038-7c1aa8a9af53",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03feec4a-409f-4eab-80dc-5af9e31629f2",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:31:09.4077076-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db3285e0-fa7e-43b4-a252-2ed9654e61ee",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "984243f8-dec5-4c2b-ae4d-eb04c7cdd01a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2f604d2d-4348-4307-9051-f55cabcae4a8",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-03T02:31:09.4077076-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "07ddb45d-0479-43bf-9e21-c3b86167cb99",
"CreateDate": "2026-08-03T02:31:09.4077076-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:31:09.4077076-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}