GET api/HGNote/Get?orderID={orderID}
It is used to get all notes which are recorded for a inspection.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
It is used to get all notes which are recorded for a inspection.
InspectorNotesToCS| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteID |
It represents the unique identifier to identify inspection notes uniquely. |
integer |
None. |
| OrderID |
It represents the unique identifier of a current inspection. |
integer |
None. |
| ReportID |
It represents the unique identifier of a property. |
integer |
None. |
| NoteDate |
It represents the date on which Notes has been sent/receive. |
date |
None. |
| Message |
It represents the date on which message got sent/received. |
string |
None. |
| MessageType |
It represents the type of a message, possible values are I, C |
string |
None. |
| ReadByEmpID |
It represents a flag that tells whether current note has been read or not. |
integer |
None. |
| ReadEmployeeName |
It represents name of a employee who reads the note/message. |
string |
None. |
| ReadDate |
It represents the date/time on which a note/message has been read. |
date |
None. |
Response Formats
application/json
{
"NoteDate": "2025-04-26T10:44:26.8548359Z",
"ReportID": 3,
"OrderID": 2,
"NoteID": 1,
"ReadDate": "2025-04-26T10:44:26.8548359Z",
"ReadByEmpID": 1,
"ReadEmployeeName": "sample string 7",
"MessageType": "sample string 6",
"Message": "sample string 5"
}
application/xml, text/xml
<InspectorNotesToCS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Inspection"> <Message>sample string 5</Message> <MessageType>sample string 6</MessageType> <NoteDate>2025-04-26T03:44:26.8548359-07:00</NoteDate> <NoteID>1</NoteID> <OrderID>2</OrderID> <ReadByEmpID>1</ReadByEmpID> <ReadDate>2025-04-26T03:44:26.8548359-07:00</ReadDate> <ReadEmployeeName>sample string 7</ReadEmployeeName> <ReportID>3</ReportID> </InspectorNotesToCS>