GET api/HGInspections/View

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

HGInspectionViewModel
NameDescriptionTypeAdditional information
OrderID

It represents the unique identifier of a inspection.

 integer

None.
ReportID

It represents the unique identifier of a property. One inspection can only associate to a single property. One property can be part of multiple inspections.

 integer

None.
ScheduleTitle

It represents title of a inspection.

 string

None.
HeaderTitle

It represents title of a inspection header.

 string

None.
AddressLine1

It represents the Address line one of a property where inspection has conducted.

 string

None.
AddressLine2

It represents the Address line two of a property where inspection has conducted.

 string

None.
OrderedBy

It represents the name of ordered party.

 string

None.
OrderedByType

It represents the type of customer who orders the current inspection. Possible values are, client, Agent

 string

None.
ClientName

It represents a name of client who orders the current inspection.

 string

None.
SchedDate_MMddyy

It represents the scheduled date on which inspection has to be conducted with MM/dd/yy format. The value to this field, will come with format in response. ex. 07/11/2018 etc.

 string

None.
ScheduledDate

It represents the scheduled date on which inspection has to be conducted. The value to this field, will come with format in response. ex. Monday 18th July 2017 etc.

 string

None.
ScheduledTime

It represents the scheduled time on which inspection has to be conducted. The value to this field, will come with format in response. ex. 02:15 PM etc.

 string

None.
ScheduledOn

It represents the scheduled date/time on which inspection has to be conducted.

 date

None.
InspectionTypeID

It represents the unique identifier of inspection type

 integer

None.
InspectionType

It represents type of a home/property inspection ex. Original, Supplemental, Re-inspection or Limited etc,

 string

None.
InspectionCategory

It represents the kind of inspection. i.e. Home, Roof, Termite etc.

 string

None.
StatusID

It represents the status id of current inspection. 0=canceled 1=Ordered 2=Confirmed 3=Not Turned in (started) 4=Turned in (submitted) 5=Report generated (inspector needs to approve) 6=Approved 7=emailed (to customer) 8=Processed (mailed if needed) 9=consultation (met customer, but no report)

 integer

None.
InspectionState

It represents the state of inspection. ex. Required field, Edit, Proof report, Approved etc.

 string

None.
ReportGenerationStatus

It represents a flag which can be used to say whether report has been generated for current inspection or not.

 integer

None.
Access

It represents the access information, which can be useful information to inspector to access the property where he needs conduct the inspection.

 string

None.
PrevReportID

It represents the previous report identifier of a property. One inspection can only associate to a single property. One property can be part of multiple inspections.

 integer

None.
AgeInfo

It represents the year the property was built in.

 string

None.
SquareFeet

It represents the area of the property

 string

None.
SlabOrCrawl

It represents the property has slab / crawl

 string

None.
TodaysSchedule

It represents the other inspector's inspections, which has to be conduct on the same scheduled date/time that of current inspection scheduled date/time.

 Collection of TodaySchedule

None.

Response Formats

application/json

Sample: 
{
  "PrevReportID": 19,
  "ReportGenerationStatus": 17,
  "StatusID": 15,
  "ReportID": 2,
  "OrderID": 1,
  "TodaysSchedule": [
    {
      "ReportID": 1,
      "InspectorName": "sample string 6",
      "InspectionLabel": "sample string 5",
      "ScheduledTime": "sample string 4",
      "ScheduledDate": "sample string 3",
      "InspectionType": "sample string 2"
    },
    {
      "ReportID": 1,
      "InspectorName": "sample string 6",
      "InspectionLabel": "sample string 5",
      "ScheduledTime": "sample string 4",
      "ScheduledDate": "sample string 3",
      "InspectionType": "sample string 2"
    }
  ],
  "InspectionTypeID": 1,
  "ScheduledOn": "2025-04-26T11:07:21.6088498Z",
  "SlabOrCrawl": "sample string 22",
  "SquareFeet": "sample string 21",
  "AgeInfo": "sample string 20",
  "Access": "sample string 18",
  "InspectionState": "sample string 16",
  "InspectionCategory": "sample string 14",
  "InspectionType": "sample string 13",
  "ScheduledTime": "sample string 12",
  "ScheduledDate": "sample string 11",
  "SchedDate_MMddyy": "sample string 10",
  "ClientName": "sample string 9",
  "OrderedByType": "sample string 8",
  "OrderedBy": "sample string 7",
  "AddressLine2": "sample string 6",
  "AddressLine1": "sample string 5",
  "HeaderTitle": "sample string 4",
  "ScheduleTitle": "sample string 3"
}

application/xml, text/xml

Sample: 
<HGInspectionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Inspection">
  <Access>sample string 18</Access>
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <AgeInfo>sample string 20</AgeInfo>
  <ClientName>sample string 9</ClientName>
  <HeaderTitle>sample string 4</HeaderTitle>
  <InspectionCategory>sample string 14</InspectionCategory>
  <InspectionState>sample string 16</InspectionState>
  <InspectionType>sample string 13</InspectionType>
  <InspectionTypeID>1</InspectionTypeID>
  <OrderID>1</OrderID>
  <OrderedBy>sample string 7</OrderedBy>
  <OrderedByType>sample string 8</OrderedByType>
  <PrevReportID>19</PrevReportID>
  <ReportGenerationStatus>17</ReportGenerationStatus>
  <ReportID>2</ReportID>
  <SchedDate_MMddyy>sample string 10</SchedDate_MMddyy>
  <ScheduleTitle>sample string 3</ScheduleTitle>
  <ScheduledDate>sample string 11</ScheduledDate>
  <ScheduledOn>2025-04-26T04:07:21.6088498-07:00</ScheduledOn>
  <ScheduledTime>sample string 12</ScheduledTime>
  <SlabOrCrawl>sample string 22</SlabOrCrawl>
  <SquareFeet>sample string 21</SquareFeet>
  <StatusID>15</StatusID>
  <TodaysSchedule>
    <TodaySchedule>
      <InspectionLabel>sample string 5</InspectionLabel>
      <InspectionType>sample string 2</InspectionType>
      <InspectorName>sample string 6</InspectorName>
      <ReportID>1</ReportID>
      <ScheduledDate>sample string 3</ScheduledDate>
      <ScheduledTime>sample string 4</ScheduledTime>
    </TodaySchedule>
    <TodaySchedule>
      <InspectionLabel>sample string 5</InspectionLabel>
      <InspectionType>sample string 2</InspectionType>
      <InspectorName>sample string 6</InspectorName>
      <ReportID>1</ReportID>
      <ScheduledDate>sample string 3</ScheduledDate>
      <ScheduledTime>sample string 4</ScheduledTime>
    </TodaySchedule>
  </TodaysSchedule>
</HGInspectionViewModel>