GET api/HGSharedData/Get
Get all supportive/master data required for homeguard system.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Get all supportive/master data required for homeguard system.
HGSharedDataModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Divisions |
It represents all the available divisions in the system. |
Collection of Division |
None. |
| Pages |
It represents all the available pages in the system. |
Collection of HGPage |
None. |
| HomeTypes |
It represents all the home types in the system. |
Collection of BuildingType |
None. |
| Descriptions |
It represents all the Descriptions in the system. |
Collection of Description |
None. |
| Findings |
It represents all the findings in the system. |
Collection of Finding |
None. |
| Templates |
It represents all the findings in the system. |
Collection of Template |
None. |
| HierarchyP |
It represents all the findings in the system. |
Collection of Hierarchy |
None. |
| Reasons |
It represents all the available drone not used reasons in the system. |
Collection of DroneNotUsedReason |
None. |
| Troubleshooting_Notes |
It represents all the available Troubleshooting notes in the system. |
Collection of Troubleshooting |
None. |
| InTransit_Menu |
It represents In-Transit menu |
Collection of InTransitMenu |
None. |
Response Formats
application/json
Sample:
{
"Divisions": [
{
"DivisionName": "sample string 2",
"DivisionId": "sample string 1"
},
{
"DivisionName": "sample string 2",
"DivisionId": "sample string 1"
}
],
"Pages": [
{
"Highlight": true,
"SectionId": 6,
"ChapterId": 3,
"PageId": 1,
"DescSort": 1.1,
"DivisionId": "sample string 4",
"PageName": "sample string 2"
},
{
"Highlight": true,
"SectionId": 6,
"ChapterId": 3,
"PageId": 1,
"DescSort": 1.1,
"DivisionId": "sample string 4",
"PageName": "sample string 2"
}
],
"HomeTypes": [
{
"OrderIndex": 1,
"Name": "sample string 2",
"BuildingTypeID": "sample string 1"
},
{
"OrderIndex": 1,
"Name": "sample string 2",
"BuildingTypeID": "sample string 1"
}
],
"Descriptions": [
{
"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"
},
{
"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"
}
],
"Findings": [
{
"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"
},
{
"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"
}
],
"Templates": [
{
"Id": 1,
"Descriptions": [
{
"PageId": 2,
"AbbrDescription": "sample string 5",
"AbbreviationName": "sample string 4",
"DivisionId": "sample string 3"
},
{
"PageId": 2,
"AbbrDescription": "sample string 5",
"AbbreviationName": "sample string 4",
"DivisionId": "sample string 3"
}
],
"Observations": [
{
"PageId": 2,
"SP": 1,
"Description": "sample string 5",
"Name": "sample string 4",
"DivisionId": "sample string 3"
},
{
"PageId": 2,
"SP": 1,
"Description": "sample string 5",
"Name": "sample string 4",
"DivisionId": "sample string 3"
}
],
"TDescription": "sample string 3",
"TName": "sample string 2"
},
{
"Id": 1,
"Descriptions": [
{
"PageId": 2,
"AbbrDescription": "sample string 5",
"AbbreviationName": "sample string 4",
"DivisionId": "sample string 3"
},
{
"PageId": 2,
"AbbrDescription": "sample string 5",
"AbbreviationName": "sample string 4",
"DivisionId": "sample string 3"
}
],
"Observations": [
{
"PageId": 2,
"SP": 1,
"Description": "sample string 5",
"Name": "sample string 4",
"DivisionId": "sample string 3"
},
{
"PageId": 2,
"SP": 1,
"Description": "sample string 5",
"Name": "sample string 4",
"DivisionId": "sample string 3"
}
],
"TDescription": "sample string 3",
"TName": "sample string 2"
}
],
"HierarchyP": [
{
"CascadeSP": 1,
"SP": 1,
"ParentSPs": "sample string 1"
},
{
"CascadeSP": 1,
"SP": 1,
"ParentSPs": "sample string 1"
}
],
"Reasons": [
{
"ReasonId": 1,
"Reason": "sample string 2"
},
{
"ReasonId": 1,
"Reason": "sample string 2"
}
],
"Troubleshooting_Notes": [
{
"TSort": 1,
"TroubleshootingID": 1,
"Notes": "sample string 3",
"Header": "sample string 2",
"InspectionType": "sample string 1"
},
{
"TSort": 1,
"TroubleshootingID": 1,
"Notes": "sample string 3",
"Header": "sample string 2",
"InspectionType": "sample string 1"
}
],
"InTransit_Menu": [
{
"Seq": 5,
"MenuValue": 2,
"UOM": "sample string 4",
"DisplayLabel": "sample string 3",
"MenuText": "sample string 1"
},
{
"Seq": 5,
"MenuValue": 2,
"UOM": "sample string 4",
"DisplayLabel": "sample string 3",
"MenuText": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<HGSharedDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.BusinessObjects.Shared">
<Descriptions>
<Description>
<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>
<Description>
<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>
</Descriptions>
<Divisions>
<Division>
<DivisionId>sample string 1</DivisionId>
<DivisionName>sample string 2</DivisionName>
</Division>
<Division>
<DivisionId>sample string 1</DivisionId>
<DivisionName>sample string 2</DivisionName>
</Division>
</Divisions>
<Findings>
<Finding>
<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>
<Finding>
<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>
</Findings>
<HierarchyP>
<Hierarchy>
<CascadeSP>1</CascadeSP>
<ParentSPs>sample string 1</ParentSPs>
<SP>1</SP>
</Hierarchy>
<Hierarchy>
<CascadeSP>1</CascadeSP>
<ParentSPs>sample string 1</ParentSPs>
<SP>1</SP>
</Hierarchy>
</HierarchyP>
<HomeTypes>
<BuildingType>
<BuildingTypeID>sample string 1</BuildingTypeID>
<Name>sample string 2</Name>
<OrderIndex>1</OrderIndex>
</BuildingType>
<BuildingType>
<BuildingTypeID>sample string 1</BuildingTypeID>
<Name>sample string 2</Name>
<OrderIndex>1</OrderIndex>
</BuildingType>
</HomeTypes>
<InTransit_Menu>
<InTransitMenu>
<DisplayLabel>sample string 3</DisplayLabel>
<MenuText>sample string 1</MenuText>
<MenuValue>2</MenuValue>
<Seq>5</Seq>
<UOM>sample string 4</UOM>
</InTransitMenu>
<InTransitMenu>
<DisplayLabel>sample string 3</DisplayLabel>
<MenuText>sample string 1</MenuText>
<MenuValue>2</MenuValue>
<Seq>5</Seq>
<UOM>sample string 4</UOM>
</InTransitMenu>
</InTransit_Menu>
<Pages>
<HGPage>
<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>
<HGPage>
<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>
</Pages>
<Reasons>
<DroneNotUsedReason>
<Reason>sample string 2</Reason>
<ReasonId>1</ReasonId>
</DroneNotUsedReason>
<DroneNotUsedReason>
<Reason>sample string 2</Reason>
<ReasonId>1</ReasonId>
</DroneNotUsedReason>
</Reasons>
<Templates>
<Template>
<Descriptions>
<TDescription>
<AbbrDescription>sample string 5</AbbrDescription>
<AbbreviationName>sample string 4</AbbreviationName>
<DivisionId>sample string 3</DivisionId>
<PageId>2</PageId>
</TDescription>
<TDescription>
<AbbrDescription>sample string 5</AbbrDescription>
<AbbreviationName>sample string 4</AbbreviationName>
<DivisionId>sample string 3</DivisionId>
<PageId>2</PageId>
</TDescription>
</Descriptions>
<Id>1</Id>
<Observations>
<TObservation>
<Description>sample string 5</Description>
<DivisionId>sample string 3</DivisionId>
<Name>sample string 4</Name>
<PageId>2</PageId>
<SP>1</SP>
</TObservation>
<TObservation>
<Description>sample string 5</Description>
<DivisionId>sample string 3</DivisionId>
<Name>sample string 4</Name>
<PageId>2</PageId>
<SP>1</SP>
</TObservation>
</Observations>
<TDescription>sample string 3</TDescription>
<TName>sample string 2</TName>
</Template>
<Template>
<Descriptions>
<TDescription>
<AbbrDescription>sample string 5</AbbrDescription>
<AbbreviationName>sample string 4</AbbreviationName>
<DivisionId>sample string 3</DivisionId>
<PageId>2</PageId>
</TDescription>
<TDescription>
<AbbrDescription>sample string 5</AbbrDescription>
<AbbreviationName>sample string 4</AbbreviationName>
<DivisionId>sample string 3</DivisionId>
<PageId>2</PageId>
</TDescription>
</Descriptions>
<Id>1</Id>
<Observations>
<TObservation>
<Description>sample string 5</Description>
<DivisionId>sample string 3</DivisionId>
<Name>sample string 4</Name>
<PageId>2</PageId>
<SP>1</SP>
</TObservation>
<TObservation>
<Description>sample string 5</Description>
<DivisionId>sample string 3</DivisionId>
<Name>sample string 4</Name>
<PageId>2</PageId>
<SP>1</SP>
</TObservation>
</Observations>
<TDescription>sample string 3</TDescription>
<TName>sample string 2</TName>
</Template>
</Templates>
<Troubleshooting_Notes>
<Troubleshooting>
<Header>sample string 2</Header>
<InspectionType>sample string 1</InspectionType>
<Notes>sample string 3</Notes>
<TSort>1</TSort>
<TroubleshootingID>1</TroubleshootingID>
</Troubleshooting>
<Troubleshooting>
<Header>sample string 2</Header>
<InspectionType>sample string 1</InspectionType>
<Notes>sample string 3</Notes>
<TSort>1</TSort>
<TroubleshootingID>1</TroubleshootingID>
</Troubleshooting>
</Troubleshooting_Notes>
</HGSharedDataModel>