GET api/HGDescriptions

Gets list of all available descriptions in the system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Gets list of all available descriptions in the system.

Description
NameDescriptionTypeAdditional information
Id

It represents a Description label, not a unique identifier. A Description can be identified uniquely by using combination of DivisionID, PageID, Id

 string

None.
PageId

It represents associated page identifier to a description

 integer

None.
DivisionId

It represents associated division identifier to a description.

 string

None.
AbbreviationName

It represents the name of associated abbreviation identifier to a description. In IOS app, we need to bind this field beside to each check-box under Descriptions section.

 string

None.
AbbrDescription

It represents the description text of associated abbreviation to a Description. In IOS app, We need to bind this field to a text input, after selecting a specific check-box.

 string

None.
SP

It represents associated Standard Phrase identifier to a description.

 integer

None.
ParentDescriptions

It represents the multiple parent abbreviation identifiers associated to a Standard Phrase identifier.

 string

None.
Fillins

It represents list of Fillin associated to a Description.

 Collection of KeyValue

None.
Hierarchy

It represents list of CascadeSP's hierarchy associated to a standard phrase.

 Collection of SPHierarchy

None.

Response Formats

application/json

Sample: 
{
  "PageId": 2,
  "Fillins": [
    {
      "Word": "sample string 1"
    },
    {
      "Word": "sample string 1"
    }
  ],
  "Hierarchy": [
    {
      "Generation": 1,
      "CascadeSP": 1,
      "SP": 1,
      "ParentSPs": "sample string 1"
    },
    {
      "Generation": 1,
      "CascadeSP": 1,
      "SP": 1,
      "ParentSPs": "sample string 1"
    }
  ],
  "SP": 1,
  "ParentDescriptions": "sample string 6",
  "AbbrDescription": "sample string 5",
  "AbbreviationName": "sample string 4",
  "DivisionId": "sample string 3",
  "Id": "sample string 1"
}

application/xml, text/xml

Sample: 
<Description xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Shared">
  <AbbrDescription>sample string 5</AbbrDescription>
  <AbbreviationName>sample string 4</AbbreviationName>
  <DivisionId>sample string 3</DivisionId>
  <Fillins>
    <KeyValue>
      <Word>sample string 1</Word>
    </KeyValue>
    <KeyValue>
      <Word>sample string 1</Word>
    </KeyValue>
  </Fillins>
  <Hierarchy>
    <SPHierarchy>
      <CascadeSP>1</CascadeSP>
      <Generation>1</Generation>
      <ParentSPs>sample string 1</ParentSPs>
      <SP>1</SP>
    </SPHierarchy>
    <SPHierarchy>
      <CascadeSP>1</CascadeSP>
      <Generation>1</Generation>
      <ParentSPs>sample string 1</ParentSPs>
      <SP>1</SP>
    </SPHierarchy>
  </Hierarchy>
  <Id>sample string 1</Id>
  <PageId>2</PageId>
  <ParentDescriptions>sample string 6</ParentDescriptions>
  <SP>1</SP>
</Description>