GET api/ParentLogin/GetHomeDataList?InstituteYearId={InstituteYearId}&StudentId={StudentId}&AppVersion={AppVersion}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InstituteYearId | string |
Required |
|
| StudentId | string |
Required |
|
| AppVersion | string |
Required |
Body Parameters
None.
Response Information
Resource Description
HomeObject| Name | Description | Type | Additional information |
|---|---|---|---|
| IsShowFeeCard | boolean |
None. |
|
| MCQMessage | string |
None. |
|
| ResultFlag | string |
None. |
|
| Message | string |
None. |
|
| InstituteIconUrl | string |
None. |
|
| StripMessage | string |
None. |
|
| IsStripDisplay | string |
None. |
|
| StripDisplayUrl | string |
None. |
|
| PendingItemsList | Collection of PendingItemsList |
None. |
|
| MessageList | Collection of MessageObject |
None. |
|
| HomeSubModule | Collection of HomeSubModule |
None. |
|
| IsAdMobIsVisible | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsAdMobIsVisible": "sample string 1",
"IsShowFeeCard": true,
"MCQMessage": "sample string 2",
"ResultFlag": "sample string 3",
"Message": "sample string 4",
"InstituteIconUrl": "sample string 5",
"StripMessage": "sample string 6",
"IsStripDisplay": "sample string 7",
"StripDisplayUrl": "sample string 8",
"PendingItemsList": [
{
"SubType": "sample string 1",
"Url": "sample string 2",
"ModuleId": "sample string 1",
"ModuleColor": "sample string 2",
"MessageId": "sample string 3",
"Title": "sample string 4",
"SubTitle": "sample string 5",
"Date": "sample string 6",
"Description": "sample string 7",
"IsRead": "sample string 8",
"IsDocAvailable": "sample string 9",
"IsFavorite": "sample string 10"
},
{
"SubType": "sample string 1",
"Url": "sample string 2",
"ModuleId": "sample string 1",
"ModuleColor": "sample string 2",
"MessageId": "sample string 3",
"Title": "sample string 4",
"SubTitle": "sample string 5",
"Date": "sample string 6",
"Description": "sample string 7",
"IsRead": "sample string 8",
"IsDocAvailable": "sample string 9",
"IsFavorite": "sample string 10"
}
],
"MessageList": [
{
"ResultFlag": "sample string 1",
"Message": "sample string 2",
"Id": "sample string 3",
"MessageText": "sample string 4",
"Date": "sample string 5",
"ImageUrl": "sample string 6",
"MonthName": "sample string 7",
"MonthCount": "sample string 8"
},
{
"ResultFlag": "sample string 1",
"Message": "sample string 2",
"Id": "sample string 3",
"MessageText": "sample string 4",
"Date": "sample string 5",
"ImageUrl": "sample string 6",
"MonthName": "sample string 7",
"MonthCount": "sample string 8"
}
],
"HomeSubModule": [
{
"ModuleId": "sample string 1",
"ModuleName": "sample string 2"
},
{
"ModuleId": "sample string 1",
"ModuleName": "sample string 2"
}
]
}
text/html
Sample:
{"IsAdMobIsVisible":"sample string 1","IsShowFeeCard":true,"MCQMessage":"sample string 2","ResultFlag":"sample string 3","Message":"sample string 4","InstituteIconUrl":"sample string 5","StripMessage":"sample string 6","IsStripDisplay":"sample string 7","StripDisplayUrl":"sample string 8","PendingItemsList":[{"SubType":"sample string 1","Url":"sample string 2","ModuleId":"sample string 1","ModuleColor":"sample string 2","MessageId":"sample string 3","Title":"sample string 4","SubTitle":"sample string 5","Date":"sample string 6","Description":"sample string 7","IsRead":"sample string 8","IsDocAvailable":"sample string 9","IsFavorite":"sample string 10"},{"SubType":"sample string 1","Url":"sample string 2","ModuleId":"sample string 1","ModuleColor":"sample string 2","MessageId":"sample string 3","Title":"sample string 4","SubTitle":"sample string 5","Date":"sample string 6","Description":"sample string 7","IsRead":"sample string 8","IsDocAvailable":"sample string 9","IsFavorite":"sample string 10"}],"MessageList":[{"ResultFlag":"sample string 1","Message":"sample string 2","Id":"sample string 3","MessageText":"sample string 4","Date":"sample string 5","ImageUrl":"sample string 6","MonthName":"sample string 7","MonthCount":"sample string 8"},{"ResultFlag":"sample string 1","Message":"sample string 2","Id":"sample string 3","MessageText":"sample string 4","Date":"sample string 5","ImageUrl":"sample string 6","MonthName":"sample string 7","MonthCount":"sample string 8"}],"HomeSubModule":[{"ModuleId":"sample string 1","ModuleName":"sample string 2"},{"ModuleId":"sample string 1","ModuleName":"sample string 2"}]}
application/xml, text/xml
Sample:
<ParentLoginModels.HomeObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
<HomeSubModule>
<ParentLoginModels.HomeSubModule>
<ModuleId>sample string 1</ModuleId>
<ModuleName>sample string 2</ModuleName>
</ParentLoginModels.HomeSubModule>
<ParentLoginModels.HomeSubModule>
<ModuleId>sample string 1</ModuleId>
<ModuleName>sample string 2</ModuleName>
</ParentLoginModels.HomeSubModule>
</HomeSubModule>
<InstituteIconUrl>sample string 5</InstituteIconUrl>
<IsAdMobIsVisible>sample string 1</IsAdMobIsVisible>
<IsShowFeeCard>true</IsShowFeeCard>
<IsStripDisplay>sample string 7</IsStripDisplay>
<MCQMessage>sample string 2</MCQMessage>
<Message>sample string 4</Message>
<MessageList>
<ParentMessageModels.MessageObject>
<Date>sample string 5</Date>
<Id>sample string 3</Id>
<ImageUrl>sample string 6</ImageUrl>
<Message>sample string 2</Message>
<MessageText>sample string 4</MessageText>
<MonthCount>sample string 8</MonthCount>
<MonthName>sample string 7</MonthName>
<ResultFlag>sample string 1</ResultFlag>
</ParentMessageModels.MessageObject>
<ParentMessageModels.MessageObject>
<Date>sample string 5</Date>
<Id>sample string 3</Id>
<ImageUrl>sample string 6</ImageUrl>
<Message>sample string 2</Message>
<MessageText>sample string 4</MessageText>
<MonthCount>sample string 8</MonthCount>
<MonthName>sample string 7</MonthName>
<ResultFlag>sample string 1</ResultFlag>
</ParentMessageModels.MessageObject>
</MessageList>
<PendingItemsList>
<ParentLoginModels.PendingItemsList>
<Date>sample string 6</Date>
<Description>sample string 7</Description>
<IsDocAvailable>sample string 9</IsDocAvailable>
<IsFavorite>sample string 10</IsFavorite>
<IsRead>sample string 8</IsRead>
<MessageId>sample string 3</MessageId>
<ModuleColor>sample string 2</ModuleColor>
<ModuleId>sample string 1</ModuleId>
<SubTitle>sample string 5</SubTitle>
<SubType>sample string 1</SubType>
<Title>sample string 4</Title>
<Url>sample string 2</Url>
</ParentLoginModels.PendingItemsList>
<ParentLoginModels.PendingItemsList>
<Date>sample string 6</Date>
<Description>sample string 7</Description>
<IsDocAvailable>sample string 9</IsDocAvailable>
<IsFavorite>sample string 10</IsFavorite>
<IsRead>sample string 8</IsRead>
<MessageId>sample string 3</MessageId>
<ModuleColor>sample string 2</ModuleColor>
<ModuleId>sample string 1</ModuleId>
<SubTitle>sample string 5</SubTitle>
<SubType>sample string 1</SubType>
<Title>sample string 4</Title>
<Url>sample string 2</Url>
</ParentLoginModels.PendingItemsList>
</PendingItemsList>
<ResultFlag>sample string 3</ResultFlag>
<StripDisplayUrl>sample string 8</StripDisplayUrl>
<StripMessage>sample string 6</StripMessage>
</ParentLoginModels.HomeObject>