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": "032a8091-9976-4bb1-a4c4-e4f098a1622b",
"Asset": {
"AssetId": "9dfd17ce-135d-4cc6-8cc8-82c686c79050",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "79058b1b-1412-4cd3-ba1e-02e2829afe28",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d027a18f-ddbc-47b1-8949-2879616f83ee",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5e172b42-0cc9-476a-926c-854215e49d6d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"MeasurementValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3b59e05f-b457-4214-91aa-19b0590acc13",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"MeasurementValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bc608efb-6577-4f32-a527-5f2b76db7bf6",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "047cca44-1fe9-46fa-83bb-0fb475d392a1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "79e88975-18b5-4afc-858a-c030670eb10d",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-19T18:28:48.0900806-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d627d602-721d-42ba-858e-3d8f7ba6311a",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "032a8091-9976-4bb1-a4c4-e4f098a1622b",
"Asset": {
"AssetId": "9dfd17ce-135d-4cc6-8cc8-82c686c79050",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "79058b1b-1412-4cd3-ba1e-02e2829afe28",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d027a18f-ddbc-47b1-8949-2879616f83ee",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5e172b42-0cc9-476a-926c-854215e49d6d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"MeasurementValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3b59e05f-b457-4214-91aa-19b0590acc13",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"MeasurementValueNeededDate": "2025-11-19T18:28:48.0900806-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bc608efb-6577-4f32-a527-5f2b76db7bf6",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "047cca44-1fe9-46fa-83bb-0fb475d392a1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "79e88975-18b5-4afc-858a-c030670eb10d",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-19T18:28:48.0900806-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d627d602-721d-42ba-858e-3d8f7ba6311a",
"CreateDate": "2025-11-19T18:28:48.0900806-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-19T18:28:48.0900806-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}