GET api/HGObservations

Gets list of all available findings in the system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Gets list of all available findings in the system.

Finding
NameDescriptionTypeAdditional information
PageId

It represents associated division identifier to a observation.

 integer

None.
DivisionId

It represents associated division identifier to a description.

 string

None.
Id

This is the sort order for how findings are to appear on the observations page. Across first, then down. Note that this is an alphanumeric column, so it is possible that an alpha character might appear. If it does, 100a should sort after 100 but before 101.

 string

None.
SP

It represents associated standard phrase identifier to a observation. Every finding should have a associated standard phrase.

 integer

None.
StandardPhrase

It represents associated standard phrase entity to a observation. Every finding must have a associated standard phrase.

 SPProperty

None.
DefaultValue

It represents default selection of associated standard phrase identifier to a observation. In IOS app, SP must be selected by default when value is 1

 integer

None.
CascadeSP

It represents default selection of associated standard phrase identifier. In IOS app, CascadeSP must be selected by default when value is 1

 integer

None.
ShowCSP

It represents CascadeSp visibility. In IOS app, ShowCSP must be selected by default when value is 1

 integer

None.
Hierarchy

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

 Collection of SPHierarchy

None.

Response Formats

application/json

Sample: 
{
  "PageId": 1,
  "StandardPhrase": {
    "IsActionItem": true,
    "PhotoRequired": 7,
    "NeedToEdit": 6,
    "Type": 4,
    "SP": 1,
    "Fillins": [
      {
        "OrderIndex": 4,
        "SP": 1,
        "FillinType": "sample string 3",
        "Word": "sample string 2"
      },
      {
        "OrderIndex": 4,
        "SP": 1,
        "FillinType": "sample string 3",
        "Word": "sample string 2"
      }
    ],
    "Name": "sample string 3",
    "Description": "sample string 2"
  },
  "Hierarchy": [
    {
      "Generation": 1,
      "CascadeSP": 1,
      "SP": 1,
      "ParentSPs": "sample string 1"
    },
    {
      "Generation": 1,
      "CascadeSP": 1,
      "SP": 1,
      "ParentSPs": "sample string 1"
    }
  ],
  "ShowCSP": 1,
  "CascadeSP": 1,
  "DefaultValue": 1,
  "SP": 1,
  "Id": "sample string 3",
  "DivisionId": "sample string 2"
}

application/xml, text/xml

Sample: 
<Finding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Shared">
  <CascadeSP>1</CascadeSP>
  <DefaultValue>1</DefaultValue>
  <DivisionId>sample string 2</DivisionId>
  <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 3</Id>
  <PageId>1</PageId>
  <SP>1</SP>
  <ShowCSP>1</ShowCSP>
  <StandardPhrase>
    <Description>sample string 2</Description>
    <Fillins>
      <FillinProperty>
        <FillinType>sample string 3</FillinType>
        <OrderIndex>4</OrderIndex>
        <SP>1</SP>
        <Word>sample string 2</Word>
      </FillinProperty>
      <FillinProperty>
        <FillinType>sample string 3</FillinType>
        <OrderIndex>4</OrderIndex>
        <SP>1</SP>
        <Word>sample string 2</Word>
      </FillinProperty>
    </Fillins>
    <IsActionItem>true</IsActionItem>
    <Name>sample string 3</Name>
    <NeedToEdit>6</NeedToEdit>
    <PhotoRequired>7</PhotoRequired>
    <SP>1</SP>
    <Type>4</Type>
  </StandardPhrase>
</Finding>