Account
This endpoint is used to get the information about the current user.
| API | Description |
|---|---|
| GET api/Account/WhoAmI |
This endpoint is used to get the information about the current user. |
| GET api/Account/CustomFillins |
To get all available custom fill-ins created by logged in employee for home inspection type. |
HGPage
To get all the available pages in the system across different divisions.
| API | Description |
|---|---|
| GET api/HGPage/Get |
Gets list of all available pages in the system. |
| GET api/HGPage |
Gets list of all available pages in the system. |
HGInspections
To get all inspection specific information related/assigned to logged in user.
| API | Description |
|---|---|
| GET api/HGInspections/Get |
To get all scheduled inspections which are assigned to logged in user. |
| GET api/HGInspections/View |
No documentation available. |
| PUT api/HGInspections/PutDummyInspection |
It is a dummy/help API call for representation of inspection data structure that consumer must follow. |
| POST api/HGInspections/ValidateInspection |
It is the first API call that must be raised in order to submit the inspection details. It validates the submitted inspection details, if the submitted inspection details are valid, then it will generates a batchid, which is a GUID, it must be used in all subsequent API calls. |
| POST api/HGInspections/UploadImages |
It is used to upload the images against a specific inspection batch wise using a valid batchid. This request should be a multipart request means it contains images and form-data. Add images to the key name "files" and supply acquired batchid from previous call to the key name "batchid" |
| POST api/HGInspections/SubmitInspectionDetails |
It is used to trigger the submit inspection procedure after completion of image upload procedure. |
| GET api/HGInspections/DownloadInspectionReport?inspectionId={inspectionId}&type={type} |
It is used to download the inspection report. |
| GET api/HGInspections/EditInspection?orderID={orderID}&toEditInspection={toEditInspection} |
It is used to get the specific inspection details |
| POST api/HGInspections/ApproveInspection |
It is used to approve the inspection. Need to send value to orderid property/field/key. Send "false" to IsEdit key |
| POST api/HGInspections/SendEmailFeeReceipt |
It is used to send inspection fee receipt to mentioned customers. |
| GET api/HGInspections/GetAgentOrdersInfo?reportIDs={reportIDs} |
To get agents orders information, last orderdate and total orders in 365 days from agent of that property. |
| GET api/HGInspections/DownloadAgentPicture?agentID={agentID} |
No documentation available. |
| POST api/HGInspections/UpdateTransitData |
No documentation available. |
| PUT api/HGInspections |
It is a dummy/help API call for representation of inspection data structure that consumer must follow. |
| GET api/HGInspections?inspectionId={inspectionId}&type={type} |
It is used to download the inspection report. |
| GET api/HGInspections?orderID={orderID}&toEditInspection={toEditInspection} |
It is used to get the specific inspection details |
| GET api/HGInspections?reportIDs={reportIDs} |
To get agents orders information, last orderdate and total orders in 365 days from agent of that property. |
| GET api/HGInspections?agentID={agentID} |
No documentation available. |
HGDescriptions
To get all descriptions master data across different pages/divisions.
| API | Description |
|---|---|
| GET api/HGDescriptions/Get |
Gets list of all available descriptions in the system. |
| GET api/HGDescriptions |
Gets list of all available descriptions in the system. |
HGDivision
It represents division entity in the system. In IOS app, we show all available divisions at left side menu.
| API | Description |
|---|---|
| GET api/HGDivision/Get |
Gets list of all available divisions in the system. |
| GET api/HGDivision |
Gets list of all available divisions in the system. |
HGFillin
It is used to get all user added fillins.
| API | Description |
|---|---|
| GET api/HGFillin/Get?empId={empId}&deptId={deptId} |
No documentation available. |
| POST api/HGFillin/Post |
It is used to add multiple fillins added by a employee |
| POST api/HGFillin/DeleteFillin |
It is used to delete selected fillins |
| GET api/HGFillin?empId={empId}&deptId={deptId} |
No documentation available. |
HGNote
It is used perform required operations on AppNotes table. Communication happened between a inspector and customer service representative will be recorded in AppNotes table.
| API | Description |
|---|---|
| GET api/HGNote/Get?orderID={orderID} |
It is used to get all notes which are recorded for a inspection. |
| POST api/HGNote/Post |
It is used to add notes to AppNotes table. |
| GET api/HGNote?orderID={orderID} |
It is used to get all notes which are recorded for a inspection. |
| POST api/HGNote |
It is used to add notes to AppNotes table. |
HGObservations
To get all available findings in the system.
| API | Description |
|---|---|
| GET api/HGObservations/Get |
Gets list of all available findings in the system. |
| GET api/HGObservations |
Gets list of all available findings in the system. |
HGHomeTypes
To get all available list of home types in the system.
| API | Description |
|---|---|
| GET api/HGHomeTypes/Get |
To get all available list of home types in the system. |
| GET api/HGHomeTypes |
To get all available list of home types in the system. |
HGSharedData
To get all supportive/master data required for homeguard system.
| API | Description |
|---|---|
| GET api/HGSharedData/Get |
Get all supportive/master data required for homeguard system. |
| GET api/HGSharedData/GetTroubleshootings |
No documentation available. |