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": "bc417f68-3faa-4664-8d65-5fc6367f992e",
"Asset": {
"AssetId": "19926da3-d4e3-439d-8efc-7b0ede2109b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9444a38e-8e8b-4a15-98f2-23a82413bb7c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "87975be4-bbba-40aa-bb06-afe4267d4a99",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "12bbe41b-29fa-46d8-9762-4940d61d3147",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"MeasurementValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ac340b38-f342-452b-80b8-f2c9fa788589",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"MeasurementValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ccb7764a-5733-47f7-8e6d-6f73e30905bd",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5158e129-6b64-4895-89f0-da5a27146649",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a65ba3f7-81a1-4651-be5a-e02c6f60f4e1",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-24T14:17:35.0786084-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d19a330f-adc3-4a3a-aa20-5f17d33ed580",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "bc417f68-3faa-4664-8d65-5fc6367f992e",
"Asset": {
"AssetId": "19926da3-d4e3-439d-8efc-7b0ede2109b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9444a38e-8e8b-4a15-98f2-23a82413bb7c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "87975be4-bbba-40aa-bb06-afe4267d4a99",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "12bbe41b-29fa-46d8-9762-4940d61d3147",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"MeasurementValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ac340b38-f342-452b-80b8-f2c9fa788589",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"MeasurementValueNeededDate": "2025-04-24T14:17:35.0786084-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ccb7764a-5733-47f7-8e6d-6f73e30905bd",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5158e129-6b64-4895-89f0-da5a27146649",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a65ba3f7-81a1-4651-be5a-e02c6f60f4e1",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-24T14:17:35.0786084-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d19a330f-adc3-4a3a-aa20-5f17d33ed580",
"CreateDate": "2025-04-24T14:17:35.0786084-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T14:17:35.0786084-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}