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": "58f96e9a-96e2-47f2-844d-7fb2b9beaee7",
"Asset": {
"AssetId": "fbb8fc9f-ec47-4a83-b607-8711dea5069c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "39235e2a-8d19-4b5c-97d0-dad7961ca5af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9c1f3ee8-a898-4fd8-a859-3a1dbebd58ea",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a62e0c6b-6146-49b4-8c6f-e69d61256a12",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d716660d-e0bd-4127-a74d-22494b225459",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af95e6b0-0990-416e-af6c-6bc950a57b82",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b1c6165f-88a8-47f4-8b81-41f02d589b96",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ca1a252-14de-48db-beb1-a4ee3fa3cb40",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T08:35:38.7777529-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0fadc785-38c0-403d-a4e9-3809cc5d9bcf",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "58f96e9a-96e2-47f2-844d-7fb2b9beaee7",
"Asset": {
"AssetId": "fbb8fc9f-ec47-4a83-b607-8711dea5069c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "39235e2a-8d19-4b5c-97d0-dad7961ca5af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9c1f3ee8-a898-4fd8-a859-3a1dbebd58ea",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a62e0c6b-6146-49b4-8c6f-e69d61256a12",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d716660d-e0bd-4127-a74d-22494b225459",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:35:38.7777529-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af95e6b0-0990-416e-af6c-6bc950a57b82",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "b1c6165f-88a8-47f4-8b81-41f02d589b96",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ca1a252-14de-48db-beb1-a4ee3fa3cb40",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T08:35:38.7777529-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0fadc785-38c0-403d-a4e9-3809cc5d9bcf",
"CreateDate": "2025-06-02T08:35:38.7777529-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:35:38.7777529-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}