GET api/HGHomeTypes

To get all available list of home types in the system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

To get all available list of home types in the system.

BuildingType
NameDescriptionTypeAdditional information
BuildingTypeID

It represents short form of the building type. It can be used to uniquely identify the building/home type.

 string

None.
Name

It represents the full form of building/home type name.

 string

None.
OrderIndex

It represents the order in which the building types By default, all building/home types would ordered by OrderIndex field.

 integer

None.

Response Formats

application/json

Sample: 
{
  "OrderIndex": 1,
  "Name": "sample string 2",
  "BuildingTypeID": "sample string 1"
}

application/xml, text/xml

Sample: 
<BuildingType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Shared">
  <BuildingTypeID>sample string 1</BuildingTypeID>
  <Name>sample string 2</Name>
  <OrderIndex>1</OrderIndex>
</BuildingType>