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": "ca0af816-859a-47bd-8180-2e2c8b8831c3",
"Asset": {
"AssetId": "aefc07b8-df9d-4fc7-adcd-c2c73b0753ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3cc0cf81-9ccc-45ab-9f56-9f953e92d18e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "83bcf4b5-c79e-4aaf-82cf-bd2b8e6192fb",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a12c779b-cd1c-4f23-a0c9-c9442af79c30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "704842cc-4d6c-4c91-b683-fce99107c608",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f33e54a0-06f3-41ea-b499-b5f6f9ef1eeb",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "c4010b9f-dcdd-42ca-afdf-b766698e0f0d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "77b647e3-b679-4929-b340-4dfb9821967b",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T05:57:02.170311-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "73cdfa9c-e147-4746-9997-4fd17fa711a9",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "ca0af816-859a-47bd-8180-2e2c8b8831c3",
"Asset": {
"AssetId": "aefc07b8-df9d-4fc7-adcd-c2c73b0753ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3cc0cf81-9ccc-45ab-9f56-9f953e92d18e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "83bcf4b5-c79e-4aaf-82cf-bd2b8e6192fb",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a12c779b-cd1c-4f23-a0c9-c9442af79c30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "704842cc-4d6c-4c91-b683-fce99107c608",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:57:02.170311-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f33e54a0-06f3-41ea-b499-b5f6f9ef1eeb",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "c4010b9f-dcdd-42ca-afdf-b766698e0f0d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "77b647e3-b679-4929-b340-4dfb9821967b",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T05:57:02.170311-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "73cdfa9c-e147-4746-9997-4fd17fa711a9",
"CreateDate": "2025-02-05T05:57:02.170311-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:57:02.170311-08:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}