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": "2a0c3c68-628d-49de-acc0-b8588946e1c5",
"Asset": {
"AssetId": "3c02d4bf-b5a0-480f-9913-44bd50b234e0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "30a34595-4f44-4933-89b8-a5889410091d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "10256ebb-34bf-4968-8f83-30f199d6266d",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ca2751cc-8a13-4dc6-ab7a-db7e57930cca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"MeasurementValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "99d8d046-76a3-4160-a6b2-5b953100f6d4",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"MeasurementValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "69087e7e-e544-4fcb-bc0a-29427e3cf549",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d085b4bc-41ca-4499-bb94-acf1dcbe3ce0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4c7c0c84-b18c-406d-b4cb-1873ac6c901f",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-26T03:06:15.9307153-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "055bbd24-365a-4c2e-97cb-70b7e9392472",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "2a0c3c68-628d-49de-acc0-b8588946e1c5",
"Asset": {
"AssetId": "3c02d4bf-b5a0-480f-9913-44bd50b234e0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "30a34595-4f44-4933-89b8-a5889410091d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "10256ebb-34bf-4968-8f83-30f199d6266d",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ca2751cc-8a13-4dc6-ab7a-db7e57930cca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"MeasurementValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "99d8d046-76a3-4160-a6b2-5b953100f6d4",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"MeasurementValueNeededDate": "2024-12-26T03:06:15.9307153-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "69087e7e-e544-4fcb-bc0a-29427e3cf549",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d085b4bc-41ca-4499-bb94-acf1dcbe3ce0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4c7c0c84-b18c-406d-b4cb-1873ac6c901f",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-26T03:06:15.9307153-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "055bbd24-365a-4c2e-97cb-70b7e9392472",
"CreateDate": "2024-12-26T03:06:15.9307153-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-26T03:06:15.9307153-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}