GET api/HGPage

Gets list of all available pages in the system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Gets list of all available pages in the system.

HGPage
NameDescriptionTypeAdditional information
PageId

It represents the identifier to uniquely identify a page By default pages would be sorted/ordered by PageId column.

 integer

None.
PageName

It represents the name of a page.

 string

None.
ChapterId

It represents the associated chapter identifier for a page. When saving Descriptions data to database, we need to copy this column/property value to AppRptDescription table/entity.

 integer

None.
DivisionId

It represents the associated division identifier/label.

 string

None.
DescSort

It field is used to determine the sort order for report generation. This value to be copied into AppRptDescriptions.Sort, when saving information under description section.

 decimal number

None.
Highlight

It represents that this page has some required fields. A value of True denotes that this page has some required fields. A value of False denotes that this page doesn't have required fields.

 boolean

None.
SectionId

It represents the section that relevant to the page.

 integer

None.

Response Formats

application/json

Sample: 
{
  "Highlight": true,
  "SectionId": 6,
  "ChapterId": 3,
  "PageId": 1,
  "DescSort": 1.1,
  "DivisionId": "sample string 4",
  "PageName": "sample string 2"
}

application/xml, text/xml

Sample: 
<HGPage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Shared">
  <ChapterId>3</ChapterId>
  <DescSort>1.1</DescSort>
  <DivisionId>sample string 4</DivisionId>
  <Highlight>true</Highlight>
  <PageId>1</PageId>
  <PageName>sample string 2</PageName>
  <SectionId>6</SectionId>
</HGPage>