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": "4ddc9697-047d-41ad-8773-c23102554032",
"Asset": {
"AssetId": "c35437da-a6e9-43f3-8521-1f88c39140d2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5c29ee56-e6df-4dd0-8b87-4ea293bf3a74",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "754f4b3e-44c6-42f9-aa8b-03cc8f39beb7",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7d8eca9e-db7a-44f8-a145-505d11f87d08",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3e2598cc-e079-4597-afec-b6490fc5a662",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6ed0bdb8-7d32-43e1-9832-7bae86e015af",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "661bdded-4b7c-4550-817c-98efce5b6cb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cdeda3cc-eee4-4277-b9cb-135fb5a38e98",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T22:50:56.3663219-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9a7ad820-3cd7-4741-adea-3ba8d2ec0c55",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "4ddc9697-047d-41ad-8773-c23102554032",
"Asset": {
"AssetId": "c35437da-a6e9-43f3-8521-1f88c39140d2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5c29ee56-e6df-4dd0-8b87-4ea293bf3a74",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "754f4b3e-44c6-42f9-aa8b-03cc8f39beb7",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7d8eca9e-db7a-44f8-a145-505d11f87d08",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3e2598cc-e079-4597-afec-b6490fc5a662",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"MeasurementValueNeededDate": "2025-07-31T22:50:56.3663219-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6ed0bdb8-7d32-43e1-9832-7bae86e015af",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "661bdded-4b7c-4550-817c-98efce5b6cb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cdeda3cc-eee4-4277-b9cb-135fb5a38e98",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T22:50:56.3663219-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9a7ad820-3cd7-4741-adea-3ba8d2ec0c55",
"CreateDate": "2025-07-31T22:50:56.3663219-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T22:50:56.3663219-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}