POST api/student/search

Search for a student by age, country, gender, and hobbies.

Request Information

URI Parameters

None.

Body Parameters

The search request

Name	Description	Type	Additional information
Country	The student birth country as a two-character ISO code. Optional.	string	Matching regular expression pattern: [A-Za-z]{2} String length: inclusive between 2 and 2
ProgramCountry	The program country as a two-character ISO code. Optional. Defaults to US.	string	Matching regular expression pattern: [A-Za-z]{2} String length: inclusive between 2 and 2
Gender	The student gender as a string (either female or male). Optional.	string	Matching regular expression pattern: (female\|male)
Age	The student age in the range 14 to 18 (inclusive). Optional.	integer	Range: inclusive between 14 and 18
Hobby	One hobby for the student. Optional.	string	Matching regular expression pattern: [A-Za-z0-9 ]{0,100} String length: inclusive between 0 and 100
From	The amount of hits to skip. Used for pagination. Optional, defaults to zero.	integer	Range: inclusive between 0 and 2147483647
Size	The amount of hits to return. Used for pagination. Optional, defaults to 20.	integer	Range: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "country": "sample string 1",
  "programCountry": "sample string 2",
  "gender": "sample string 3",
  "age": 1,
  "hobby": "sample string 4",
  "from": 5,
  "size": 6
}

application/xml, text/xml

Sample:

<StudentSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Age>1</Age>
  <Country>sample string 1</Country>
  <From>5</From>
  <Gender>sample string 3</Gender>
  <Hobby>sample string 4</Hobby>
  <ProgramCountry>sample string 2</ProgramCountry>
  <Size>6</Size>
</StudentSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A search response

StudentSearchResponse

Name	Description	Type	Additional information
Students	The matching students.	Collection of StudentSearch	None.
Message	A status message	string	None.
TotalHitCount	Total number of hits.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "students": [
    {
      "id": 1,
      "name": "sample string 2",
      "interests": [
        "sample string 1",
        "sample string 2"
      ],
      "age": 3,
      "gender": "sample string 4",
      "country": "sample string 5",
      "countryName": "sample string 6",
      "programStart": "sample string 7",
      "stateChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "isWelcome": true,
      "welcomeHostFamilyId": 1,
      "religion": "sample string 9",
      "personalLetter": "sample string 10",
      "answerPersonalityHabits": "sample string 11",
      "answerBiography": "sample string 12",
      "answerMotivation": "sample string 13",
      "answerPersonalOutlook": "sample string 14",
      "isCamper": true,
      "hasHold": true,
      "studentProgramStatus": "sample string 17",
      "studentProfilePhoto": "sample string 18",
      "studentPhotos": [
        "sample string 1",
        "sample string 2"
      ],
      "studentVideo": "sample string 19"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "interests": [
        "sample string 1",
        "sample string 2"
      ],
      "age": 3,
      "gender": "sample string 4",
      "country": "sample string 5",
      "countryName": "sample string 6",
      "programStart": "sample string 7",
      "stateChoices": [
        "sample string 1",
        "sample string 2"
      ],
      "isWelcome": true,
      "welcomeHostFamilyId": 1,
      "religion": "sample string 9",
      "personalLetter": "sample string 10",
      "answerPersonalityHabits": "sample string 11",
      "answerBiography": "sample string 12",
      "answerMotivation": "sample string 13",
      "answerPersonalOutlook": "sample string 14",
      "isCamper": true,
      "hasHold": true,
      "studentProgramStatus": "sample string 17",
      "studentProfilePhoto": "sample string 18",
      "studentPhotos": [
        "sample string 1",
        "sample string 2"
      ],
      "studentVideo": "sample string 19"
    }
  ],
  "message": "sample string 1",
  "totalHitCount": 2
}

application/xml, text/xml

Sample:

<StudentSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Message>sample string 1</Message>
  <Students>
    <StudentSearch>
      <Age>3</Age>
      <AnswerBiography>sample string 12</AnswerBiography>
      <AnswerMotivation>sample string 13</AnswerMotivation>
      <AnswerPersonalOutlook>sample string 14</AnswerPersonalOutlook>
      <AnswerPersonalityHabits>sample string 11</AnswerPersonalityHabits>
      <Country>sample string 5</Country>
      <CountryName>sample string 6</CountryName>
      <Gender>sample string 4</Gender>
      <HasHold>true</HasHold>
      <Id>1</Id>
      <Interests xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Interests>
      <IsCamper>true</IsCamper>
      <IsWelcome>true</IsWelcome>
      <Name>sample string 2</Name>
      <PersonalLetter>sample string 10</PersonalLetter>
      <ProgramStart>sample string 7</ProgramStart>
      <Religion>sample string 9</Religion>
      <StateChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StateChoices>
      <StudentPhotos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StudentPhotos>
      <StudentProfilePhoto>sample string 18</StudentProfilePhoto>
      <StudentProgramStatus>sample string 17</StudentProgramStatus>
      <StudentVideo>sample string 19</StudentVideo>
      <WelcomeHostFamilyId>1</WelcomeHostFamilyId>
    </StudentSearch>
    <StudentSearch>
      <Age>3</Age>
      <AnswerBiography>sample string 12</AnswerBiography>
      <AnswerMotivation>sample string 13</AnswerMotivation>
      <AnswerPersonalOutlook>sample string 14</AnswerPersonalOutlook>
      <AnswerPersonalityHabits>sample string 11</AnswerPersonalityHabits>
      <Country>sample string 5</Country>
      <CountryName>sample string 6</CountryName>
      <Gender>sample string 4</Gender>
      <HasHold>true</HasHold>
      <Id>1</Id>
      <Interests xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Interests>
      <IsCamper>true</IsCamper>
      <IsWelcome>true</IsWelcome>
      <Name>sample string 2</Name>
      <PersonalLetter>sample string 10</PersonalLetter>
      <ProgramStart>sample string 7</ProgramStart>
      <Religion>sample string 9</Religion>
      <StateChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StateChoices>
      <StudentPhotos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StudentPhotos>
      <StudentProfilePhoto>sample string 18</StudentProfilePhoto>
      <StudentProgramStatus>sample string 17</StudentProgramStatus>
      <StudentVideo>sample string 19</StudentVideo>
      <WelcomeHostFamilyId>1</WelcomeHostFamilyId>
    </StudentSearch>
  </Students>
  <TotalHitCount>2</TotalHitCount>
</StudentSearchResponse>