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": "9f4f2860-53cb-44cd-9d1f-c017b0f2aa72", "Asset": { "AssetId": "3e166f20-db03-4904-b797-fa845d735bd6", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d31de083-1b0b-4b9f-9db3-6c2a7c9c3a8c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ee6d52bf-44fc-42d5-8033-98466f1c0e5a", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "310873eb-0ac7-4319-a5e0-fec16e008b39", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "SourceSystemId": "sample string 3", "CompanyId": "98ff81ce-1bc1-4f86-a2dc-d897315cc0aa", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "78f730f0-ac36-4de1-92d8-1403d617d8b9", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "de00e98b-e991-4f54-91de-98acbb8439c1", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "075aebea-2b5a-4e83-b77f-3c1878193350", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-24T15:06:27.9751795-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "dae13b57-189a-4e0a-9bcd-d1bc5051b846", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "9f4f2860-53cb-44cd-9d1f-c017b0f2aa72", "Asset": { "AssetId": "3e166f20-db03-4904-b797-fa845d735bd6", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d31de083-1b0b-4b9f-9db3-6c2a7c9c3a8c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ee6d52bf-44fc-42d5-8033-98466f1c0e5a", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "310873eb-0ac7-4319-a5e0-fec16e008b39", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "SourceSystemId": "sample string 3", "CompanyId": "98ff81ce-1bc1-4f86-a2dc-d897315cc0aa", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:27.9751795-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "78f730f0-ac36-4de1-92d8-1403d617d8b9", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "de00e98b-e991-4f54-91de-98acbb8439c1", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "075aebea-2b5a-4e83-b77f-3c1878193350", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-24T15:06:27.9751795-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "dae13b57-189a-4e0a-9bcd-d1bc5051b846", "CreateDate": "2024-04-24T15:06:27.9751795-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-24T15:06:27.9751795-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }