POST Api/StudentDemographics/GetStudentDistrict
Request Information
URI Parameters
None.
Body Parameters
StudentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Contact_ID | decimal number |
None. |
|
| StudentID | string |
None. |
|
| CampusName | string |
None. |
|
| UserID | string |
None. |
|
| DeviceID | string |
None. |
|
| DeviceOS | string |
None. |
|
| Version | string |
None. |
|
| accessToken | string |
Required Matching regular expression pattern: ^a4768b1a-b5c1-4561-86e7-324b8a368354$ |
Request Formats
application/json, text/json
Sample:
{
"Contact_ID": 1.0,
"StudentID": "sample string 2",
"CampusName": "sample string 3",
"UserID": "sample string 4",
"DeviceID": "sample string 5",
"DeviceOS": "sample string 6",
"Version": "sample string 7",
"accessToken": "sample string 8"
}
text/html
Sample:
{"Contact_ID":1.0,"StudentID":"sample string 2","CampusName":"sample string 3","UserID":"sample string 4","DeviceID":"sample string 5","DeviceOS":"sample string 6","Version":"sample string 7","accessToken":"sample string 8"}
application/xml, text/xml
Sample:
<StudentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model.AdminPanel"> <CampusName xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 3</CampusName> <DeviceID xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 5</DeviceID> <DeviceOS xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 6</DeviceOS> <UserID xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 4</UserID> <Version xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 7</Version> <accessToken xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 8</accessToken> <Contact_ID>1</Contact_ID> <StudentID>sample string 2</StudentID> </StudentModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
StudentDistrictDetailsReturnResult| Name | Description | Type | Additional information |
|---|---|---|---|
| status | boolean |
None. |
|
| message | string |
None. |
|
| data | Collection of StudentDistrictModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": true,
"message": "sample string 2",
"data": [
{
"StudentId": "sample string 1",
"DISTRICTNUMBER": "sample string 2",
"DistrictName": "sample string 3",
"CaseMgrID": 4.0,
"Send_School_Name": "sample string 5",
"Home_School": "sample string 6",
"CSTCASEMANAGER": 1.0,
"CaseManagerEmail": "sample string 7",
"ADDRESS": "sample string 8",
"CITY": "sample string 9",
"STATE": "sample string 10",
"ZIP_CODE": "sample string 11",
"HOMEPHONE": "sample string 12",
"ContactPhone": "sample string 13",
"Ext": "sample string 14",
"CaseManagerName": "sample string 15",
"LastName": "sample string 16",
"Firstname": "sample string 17",
"Fax": "sample string 18",
"Greetings": "sample string 19",
"Title": "sample string 20",
"Note": "sample string 21",
"IntakeCM": 22,
"EnrolledCM": 23,
"Current": 24,
"Retired": 25,
"flgEmployerContact": 26,
"LabelLarge": 27,
"LabelSmall": 28
},
{
"StudentId": "sample string 1",
"DISTRICTNUMBER": "sample string 2",
"DistrictName": "sample string 3",
"CaseMgrID": 4.0,
"Send_School_Name": "sample string 5",
"Home_School": "sample string 6",
"CSTCASEMANAGER": 1.0,
"CaseManagerEmail": "sample string 7",
"ADDRESS": "sample string 8",
"CITY": "sample string 9",
"STATE": "sample string 10",
"ZIP_CODE": "sample string 11",
"HOMEPHONE": "sample string 12",
"ContactPhone": "sample string 13",
"Ext": "sample string 14",
"CaseManagerName": "sample string 15",
"LastName": "sample string 16",
"Firstname": "sample string 17",
"Fax": "sample string 18",
"Greetings": "sample string 19",
"Title": "sample string 20",
"Note": "sample string 21",
"IntakeCM": 22,
"EnrolledCM": 23,
"Current": 24,
"Retired": 25,
"flgEmployerContact": 26,
"LabelLarge": 27,
"LabelSmall": 28
}
]
}
text/html
Sample:
{"status":true,"message":"sample string 2","data":[{"StudentId":"sample string 1","DISTRICTNUMBER":"sample string 2","DistrictName":"sample string 3","CaseMgrID":4.0,"Send_School_Name":"sample string 5","Home_School":"sample string 6","CSTCASEMANAGER":1.0,"CaseManagerEmail":"sample string 7","ADDRESS":"sample string 8","CITY":"sample string 9","STATE":"sample string 10","ZIP_CODE":"sample string 11","HOMEPHONE":"sample string 12","ContactPhone":"sample string 13","Ext":"sample string 14","CaseManagerName":"sample string 15","LastName":"sample string 16","Firstname":"sample string 17","Fax":"sample string 18","Greetings":"sample string 19","Title":"sample string 20","Note":"sample string 21","IntakeCM":22,"EnrolledCM":23,"Current":24,"Retired":25,"flgEmployerContact":26,"LabelLarge":27,"LabelSmall":28},{"StudentId":"sample string 1","DISTRICTNUMBER":"sample string 2","DistrictName":"sample string 3","CaseMgrID":4.0,"Send_School_Name":"sample string 5","Home_School":"sample string 6","CSTCASEMANAGER":1.0,"CaseManagerEmail":"sample string 7","ADDRESS":"sample string 8","CITY":"sample string 9","STATE":"sample string 10","ZIP_CODE":"sample string 11","HOMEPHONE":"sample string 12","ContactPhone":"sample string 13","Ext":"sample string 14","CaseManagerName":"sample string 15","LastName":"sample string 16","Firstname":"sample string 17","Fax":"sample string 18","Greetings":"sample string 19","Title":"sample string 20","Note":"sample string 21","IntakeCM":22,"EnrolledCM":23,"Current":24,"Retired":25,"flgEmployerContact":26,"LabelLarge":27,"LabelSmall":28}]}
application/xml, text/xml
Sample:
<StudentDistrictDetailsReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model.AdminPanel">
<data>
<StudentDistrictModel>
<ADDRESS>sample string 8</ADDRESS>
<CITY>sample string 9</CITY>
<CSTCASEMANAGER>1</CSTCASEMANAGER>
<CaseManagerEmail>sample string 7</CaseManagerEmail>
<CaseManagerName>sample string 15</CaseManagerName>
<CaseMgrID>4</CaseMgrID>
<ContactPhone>sample string 13</ContactPhone>
<Current>24</Current>
<DISTRICTNUMBER>sample string 2</DISTRICTNUMBER>
<DistrictName>sample string 3</DistrictName>
<EnrolledCM>23</EnrolledCM>
<Ext>sample string 14</Ext>
<Fax>sample string 18</Fax>
<Firstname>sample string 17</Firstname>
<Greetings>sample string 19</Greetings>
<HOMEPHONE>sample string 12</HOMEPHONE>
<Home_School>sample string 6</Home_School>
<IntakeCM>22</IntakeCM>
<LabelLarge>27</LabelLarge>
<LabelSmall>28</LabelSmall>
<LastName>sample string 16</LastName>
<Note>sample string 21</Note>
<Retired>25</Retired>
<STATE>sample string 10</STATE>
<Send_School_Name>sample string 5</Send_School_Name>
<StudentId>sample string 1</StudentId>
<Title>sample string 20</Title>
<ZIP_CODE>sample string 11</ZIP_CODE>
<flgEmployerContact>26</flgEmployerContact>
</StudentDistrictModel>
<StudentDistrictModel>
<ADDRESS>sample string 8</ADDRESS>
<CITY>sample string 9</CITY>
<CSTCASEMANAGER>1</CSTCASEMANAGER>
<CaseManagerEmail>sample string 7</CaseManagerEmail>
<CaseManagerName>sample string 15</CaseManagerName>
<CaseMgrID>4</CaseMgrID>
<ContactPhone>sample string 13</ContactPhone>
<Current>24</Current>
<DISTRICTNUMBER>sample string 2</DISTRICTNUMBER>
<DistrictName>sample string 3</DistrictName>
<EnrolledCM>23</EnrolledCM>
<Ext>sample string 14</Ext>
<Fax>sample string 18</Fax>
<Firstname>sample string 17</Firstname>
<Greetings>sample string 19</Greetings>
<HOMEPHONE>sample string 12</HOMEPHONE>
<Home_School>sample string 6</Home_School>
<IntakeCM>22</IntakeCM>
<LabelLarge>27</LabelLarge>
<LabelSmall>28</LabelSmall>
<LastName>sample string 16</LastName>
<Note>sample string 21</Note>
<Retired>25</Retired>
<STATE>sample string 10</STATE>
<Send_School_Name>sample string 5</Send_School_Name>
<StudentId>sample string 1</StudentId>
<Title>sample string 20</Title>
<ZIP_CODE>sample string 11</ZIP_CODE>
<flgEmployerContact>26</flgEmployerContact>
</StudentDistrictModel>
</data>
<message>sample string 2</message>
<status>true</status>
</StudentDistrictDetailsReturnResult>