POST api/Student/AddHouseholdData
Request Information
URI Parameters
None.
Body Parameters
HouseholdDataRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| household | HouseholdDetail |
None. |
|
| surveyee | HouseholdSurveyeeDetail |
None. |
|
| member | Collection of HouseholdMember |
None. |
|
| doc | HouseholdCommonDocument |
None. |
Request Formats
application/json, text/json
Sample:
{
"household": {
"houseid": 1,
"householdid": "sample string 2",
"state": "sample string 3",
"district": "sample string 4",
"city": "sample string 5",
"grampanchayat": "sample string 6",
"village": "sample string 7",
"hamlet": "sample string 8",
"hfirstname": "sample string 9",
"hmiddlename": "sample string 10",
"hlastname": "sample string 11",
"wfirstname": "sample string 12",
"wmiddlename": "sample string 13",
"wlastname": "sample string 14",
"akrspid": "sample string 15",
"category": "sample string 16",
"male0_5": 1,
"female0_5": 1,
"male6_12": 1,
"female6_12": 1,
"male13_17": 1,
"female13_17": 1,
"male18_40": 1,
"female18_40": 1,
"male41_60": 1,
"female41_60": 1,
"male61_above": 1,
"female61_above": 1,
"haveland": "sample string 17",
"unit": "sample string 18",
"irrigatedland": 1,
"rainfedland": 1,
"noncultivatedland": 1,
"totalownland": 1,
"sourceofirrigation": "sample string 19",
"goatssheeps": 1,
"poultrybirds": 1,
"cowbuffalo": 1,
"total": 1,
"totalinome": 1.0
},
"surveyee": {
"hrsdid": 1,
"householdid": "sample string 2",
"suervyby": "sample string 3",
"suervymobileno": "sample string 4",
"createby": "sample string 5",
"createon": "2026-10-31T19:48:25.2509787+05:30",
"photo": "sample string 6"
},
"member": [
{
"memberid": 1,
"householdid": "sample string 2",
"firstname": "sample string 3",
"middlename": "sample string 4",
"lastname": "sample string 5",
"gender": "sample string 6",
"age": 1,
"relationship": "sample string 7",
"maritalstatus": "sample string 8",
"migrationstatus": "sample string 9",
"disabilitystatus": "sample string 10",
"educationstatus": "sample string 11",
"pregnancylactationstatus": "sample string 12",
"aadharcard": "sample string 13",
"castecertificate": "sample string 14",
"ayushmancard": "sample string 15",
"bankaccount": "sample string 16",
"incomecertificate": "sample string 17",
"educationscholarship": "sample string 18",
"kuvarbaimameru": "sample string 19",
"widowpension": "sample string 20",
"oldagepension": "sample string 21",
"disabilitypension": "sample string 22",
"pmkisan": "sample string 23",
"jananisurakshayojana": "sample string 24",
"matruvandanayojana": "sample string 25",
"sankatmochanyojana": "sample string 26",
"anganwadiregistered": "sample string 27",
"currentlyattendingschool": "sample string 28",
"schoolname": "sample string 29",
"otherschoolname": "sample string 30",
"studiedatburthadi": "sample string 31",
"studiedafter2024": "sample string 32",
"chetnaworked": "sample string 33",
"chetnabeneficiary": "sample string 34",
"balshaktireceived": "sample string 35",
"pregnancymonth": 1,
"pregnancyregistered": "sample string 36",
"childagemonths": 1,
"exclusivebreastfeedingmonths": 1,
"complementaryfeedingagemonths": 1,
"createdby": "sample string 37",
"createdon": "2026-10-31T19:48:25.2509787+05:30",
"updatedby": "sample string 39",
"updatedon": "2026-10-31T19:48:25.2509787+05:30"
},
{
"memberid": 1,
"householdid": "sample string 2",
"firstname": "sample string 3",
"middlename": "sample string 4",
"lastname": "sample string 5",
"gender": "sample string 6",
"age": 1,
"relationship": "sample string 7",
"maritalstatus": "sample string 8",
"migrationstatus": "sample string 9",
"disabilitystatus": "sample string 10",
"educationstatus": "sample string 11",
"pregnancylactationstatus": "sample string 12",
"aadharcard": "sample string 13",
"castecertificate": "sample string 14",
"ayushmancard": "sample string 15",
"bankaccount": "sample string 16",
"incomecertificate": "sample string 17",
"educationscholarship": "sample string 18",
"kuvarbaimameru": "sample string 19",
"widowpension": "sample string 20",
"oldagepension": "sample string 21",
"disabilitypension": "sample string 22",
"pmkisan": "sample string 23",
"jananisurakshayojana": "sample string 24",
"matruvandanayojana": "sample string 25",
"sankatmochanyojana": "sample string 26",
"anganwadiregistered": "sample string 27",
"currentlyattendingschool": "sample string 28",
"schoolname": "sample string 29",
"otherschoolname": "sample string 30",
"studiedatburthadi": "sample string 31",
"studiedafter2024": "sample string 32",
"chetnaworked": "sample string 33",
"chetnabeneficiary": "sample string 34",
"balshaktireceived": "sample string 35",
"pregnancymonth": 1,
"pregnancyregistered": "sample string 36",
"childagemonths": 1,
"exclusivebreastfeedingmonths": 1,
"complementaryfeedingagemonths": 1,
"createdby": "sample string 37",
"createdon": "2026-10-31T19:48:25.2509787+05:30",
"updatedby": "sample string 39",
"updatedon": "2026-10-31T19:48:25.2509787+05:30"
}
],
"doc": {
"docid": 1,
"householdid": "sample string 2",
"rationcard": "sample string 3",
"landownership712": "sample string 4",
"pmaystatus": "sample string 5",
"akrspworked": "sample string 6",
"familymigration": "sample string 7",
"createdby": "sample string 8",
"createdon": "2026-10-31T19:48:25.2509787+05:30",
"updatedby": "sample string 9",
"updatedon": "2026-10-31T19:48:25.2509787+05:30"
}
}
application/xml, text/xml
Sample:
<HouseholdDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JankariPortalPIFAPI.Models">
<doc>
<akrspworked>sample string 6</akrspworked>
<createdby>sample string 8</createdby>
<createdon>2026-10-31T19:48:25.2509787+05:30</createdon>
<docid>1</docid>
<familymigration>sample string 7</familymigration>
<householdid>sample string 2</householdid>
<landownership712>sample string 4</landownership712>
<pmaystatus>sample string 5</pmaystatus>
<rationcard>sample string 3</rationcard>
<updatedby>sample string 9</updatedby>
<updatedon>2026-10-31T19:48:25.2509787+05:30</updatedon>
</doc>
<household>
<akrspid>sample string 15</akrspid>
<category>sample string 16</category>
<city>sample string 5</city>
<cowbuffalo>1</cowbuffalo>
<district>sample string 4</district>
<female0_5>1</female0_5>
<female13_17>1</female13_17>
<female18_40>1</female18_40>
<female41_60>1</female41_60>
<female61_above>1</female61_above>
<female6_12>1</female6_12>
<goatssheeps>1</goatssheeps>
<grampanchayat>sample string 6</grampanchayat>
<hamlet>sample string 8</hamlet>
<haveland>sample string 17</haveland>
<hfirstname>sample string 9</hfirstname>
<hlastname>sample string 11</hlastname>
<hmiddlename>sample string 10</hmiddlename>
<householdid>sample string 2</householdid>
<houseid>1</houseid>
<irrigatedland>1</irrigatedland>
<male0_5>1</male0_5>
<male13_17>1</male13_17>
<male18_40>1</male18_40>
<male41_60>1</male41_60>
<male61_above>1</male61_above>
<male6_12>1</male6_12>
<noncultivatedland>1</noncultivatedland>
<poultrybirds>1</poultrybirds>
<rainfedland>1</rainfedland>
<sourceofirrigation>sample string 19</sourceofirrigation>
<state>sample string 3</state>
<total>1</total>
<totalinome>1</totalinome>
<totalownland>1</totalownland>
<unit>sample string 18</unit>
<village>sample string 7</village>
<wfirstname>sample string 12</wfirstname>
<wlastname>sample string 14</wlastname>
<wmiddlename>sample string 13</wmiddlename>
</household>
<member>
<HouseholdMember>
<aadharcard>sample string 13</aadharcard>
<age>1</age>
<anganwadiregistered>sample string 27</anganwadiregistered>
<ayushmancard>sample string 15</ayushmancard>
<balshaktireceived>sample string 35</balshaktireceived>
<bankaccount>sample string 16</bankaccount>
<castecertificate>sample string 14</castecertificate>
<chetnabeneficiary>sample string 34</chetnabeneficiary>
<chetnaworked>sample string 33</chetnaworked>
<childagemonths>1</childagemonths>
<complementaryfeedingagemonths>1</complementaryfeedingagemonths>
<createdby>sample string 37</createdby>
<createdon>2026-10-31T19:48:25.2509787+05:30</createdon>
<currentlyattendingschool>sample string 28</currentlyattendingschool>
<disabilitypension>sample string 22</disabilitypension>
<disabilitystatus>sample string 10</disabilitystatus>
<educationscholarship>sample string 18</educationscholarship>
<educationstatus>sample string 11</educationstatus>
<exclusivebreastfeedingmonths>1</exclusivebreastfeedingmonths>
<firstname>sample string 3</firstname>
<gender>sample string 6</gender>
<householdid>sample string 2</householdid>
<incomecertificate>sample string 17</incomecertificate>
<jananisurakshayojana>sample string 24</jananisurakshayojana>
<kuvarbaimameru>sample string 19</kuvarbaimameru>
<lastname>sample string 5</lastname>
<maritalstatus>sample string 8</maritalstatus>
<matruvandanayojana>sample string 25</matruvandanayojana>
<memberid>1</memberid>
<middlename>sample string 4</middlename>
<migrationstatus>sample string 9</migrationstatus>
<oldagepension>sample string 21</oldagepension>
<otherschoolname>sample string 30</otherschoolname>
<pmkisan>sample string 23</pmkisan>
<pregnancylactationstatus>sample string 12</pregnancylactationstatus>
<pregnancymonth>1</pregnancymonth>
<pregnancyregistered>sample string 36</pregnancyregistered>
<relationship>sample string 7</relationship>
<sankatmochanyojana>sample string 26</sankatmochanyojana>
<schoolname>sample string 29</schoolname>
<studiedafter2024>sample string 32</studiedafter2024>
<studiedatburthadi>sample string 31</studiedatburthadi>
<updatedby>sample string 39</updatedby>
<updatedon>2026-10-31T19:48:25.2509787+05:30</updatedon>
<widowpension>sample string 20</widowpension>
</HouseholdMember>
<HouseholdMember>
<aadharcard>sample string 13</aadharcard>
<age>1</age>
<anganwadiregistered>sample string 27</anganwadiregistered>
<ayushmancard>sample string 15</ayushmancard>
<balshaktireceived>sample string 35</balshaktireceived>
<bankaccount>sample string 16</bankaccount>
<castecertificate>sample string 14</castecertificate>
<chetnabeneficiary>sample string 34</chetnabeneficiary>
<chetnaworked>sample string 33</chetnaworked>
<childagemonths>1</childagemonths>
<complementaryfeedingagemonths>1</complementaryfeedingagemonths>
<createdby>sample string 37</createdby>
<createdon>2026-10-31T19:48:25.2509787+05:30</createdon>
<currentlyattendingschool>sample string 28</currentlyattendingschool>
<disabilitypension>sample string 22</disabilitypension>
<disabilitystatus>sample string 10</disabilitystatus>
<educationscholarship>sample string 18</educationscholarship>
<educationstatus>sample string 11</educationstatus>
<exclusivebreastfeedingmonths>1</exclusivebreastfeedingmonths>
<firstname>sample string 3</firstname>
<gender>sample string 6</gender>
<householdid>sample string 2</householdid>
<incomecertificate>sample string 17</incomecertificate>
<jananisurakshayojana>sample string 24</jananisurakshayojana>
<kuvarbaimameru>sample string 19</kuvarbaimameru>
<lastname>sample string 5</lastname>
<maritalstatus>sample string 8</maritalstatus>
<matruvandanayojana>sample string 25</matruvandanayojana>
<memberid>1</memberid>
<middlename>sample string 4</middlename>
<migrationstatus>sample string 9</migrationstatus>
<oldagepension>sample string 21</oldagepension>
<otherschoolname>sample string 30</otherschoolname>
<pmkisan>sample string 23</pmkisan>
<pregnancylactationstatus>sample string 12</pregnancylactationstatus>
<pregnancymonth>1</pregnancymonth>
<pregnancyregistered>sample string 36</pregnancyregistered>
<relationship>sample string 7</relationship>
<sankatmochanyojana>sample string 26</sankatmochanyojana>
<schoolname>sample string 29</schoolname>
<studiedafter2024>sample string 32</studiedafter2024>
<studiedatburthadi>sample string 31</studiedatburthadi>
<updatedby>sample string 39</updatedby>
<updatedon>2026-10-31T19:48:25.2509787+05:30</updatedon>
<widowpension>sample string 20</widowpension>
</HouseholdMember>
</member>
<surveyee>
<createby>sample string 5</createby>
<createon>2026-10-31T19:48:25.2509787+05:30</createon>
<householdid>sample string 2</householdid>
<hrsdid>1</hrsdid>
<photo>sample string 6</photo>
<suervyby>sample string 3</suervyby>
<suervymobileno>sample string 4</suervymobileno>
</surveyee>
</HouseholdDataRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>