POST api/student/getStudentCatalogExtendedInfo

Returns Extended information about a student. If no student details are found it will return an empty response.

Request Information

URI Parameters

None.

Body Parameters

Request data

Name	Type	Additional information
StudentProgramId	integer	None.
StudentProgramIds	Collection of integer	None.
Name	string	None.

Request Formats

application/json, text/json

Sample:

{
  "studentProgramId": 1,
  "studentProgramIds": [
    1,
    2
  ],
  "name": "sample string 2"
}

application/xml, text/xml

Sample:

<StudentPdfInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Name>sample string 2</Name>
  <StudentProgramId>1</StudentProgramId>
  <StudentProgramIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StudentProgramIds>
</StudentPdfInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Extended student information

StudentResponseOfStudentPDFCatalogViewModel

Name	Type	Additional information
Message	string	None.
HasError	boolean	None.
Data	StudentPDFCatalogViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "hasError": true,
  "data": {
    "fileName": "Student-Catalog-2025-11-02_22:49:01",
    "catalogName": "sample string 1",
    "dashUrl": "sample string 2",
    "isFieldFriendly": true,
    "students": [
      {
        "id": 1,
        "imageData": {
          "imageKey": "sample string 1",
          "imageBucket": "sample string 2"
        },
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "poseidonBookingId": "sample string 4",
        "programLength": "sample string 5",
        "destinationCountry": "sample string 6",
        "destinationCountryCode": "sample string 7",
        "birthCountry": "sample string 8",
        "birthCountryCode": "sample string 9",
        "countryOfCitizenship": "sample string 10",
        "salesCountry": "sample string 11",
        "salesCountryCode": "sample string 12",
        "gender": "sample string 13",
        "age": 14,
        "dateOfBirth": "2025-11-02T22:49:01.8443359Z",
        "yearOfBirth": 15,
        "openToSingleParent": "sample string 16",
        "openToDoublePlacement": "sample string 17",
        "openToLGBTQ": "sample string 18",
        "openToPets": "sample string 19",
        "openToHostSiblings": "sample string 20",
        "openToSharingRoom": "sample string 21",
        "isCamper": true,
        "programStart": "sample string 23",
        "regionChoice": "sample string 24",
        "englishLevel": 1,
        "languageTestScore": 1,
        "livesWith": "sample string 25",
        "hasSiblings": "sample string 26",
        "numberOfSiblings": "sample string 27",
        "siblingAges": "sample string 28",
        "hasPets": "sample string 29",
        "pets": "sample string 30",
        "religion": "sample string 31",
        "religionFrequency": "sample string 32",
        "attendHostReligion": "sample string 33",
        "gradeAverage": "sample string 34",
        "graduationYear": "sample string 35",
        "allergies": "sample string 36",
        "foodRestrictions": "sample string 37",
        "epiPen": "sample string 38",
        "interviewComments": "sample string 39",
        "aboutYourself": "sample string 40",
        "chooseThreeThings": "sample string 41",
        "wantToTry": "sample string 42",
        "hobbiesAndInterests": "sample string 43",
        "describeYourself": "sample string 44",
        "passionateAbout": "sample string 45",
        "favoriteClasses": "sample string 46",
        "tellMoreAboutInterests": "sample string 47",
        "spendFreeTime": "sample string 48",
        "hostFamilyLetter": "sample string 49",
        "sports": [
          {
            "name": "sample string 1",
            "frequency": "sample string 2",
            "teamOrFun": "sample string 3"
          },
          {
            "name": "sample string 1",
            "frequency": "sample string 2",
            "teamOrFun": "sample string 3"
          }
        ],
        "music": [
          {
            "name": "sample string 1",
            "timePlaying": "sample string 2"
          },
          {
            "name": "sample string 1",
            "timePlaying": "sample string 2"
          }
        ],
        "musicTimePlaying": "sample string 50",
        "tv": "sample string 51",
        "movies": "sample string 52",
        "foods": "sample string 53",
        "saturdayNightActivities": "sample string 54",
        "talkativeOrQuiet": "sample string 55",
        "outgoingOrShy": "sample string 56",
        "messyOrOrganized": "sample string 57",
        "flexibleOrRigid": "sample string 58",
        "hasStateChoices": true,
        "stateChoices": "sample string 60",
        "whyStudyAbroad": "sample string 61",
        "whySuccessfulStudent": "sample string 62",
        "favoriteActivities": "sample string 63",
        "goalsInLife": "sample string 64"
      },
      {
        "id": 1,
        "imageData": {
          "imageKey": "sample string 1",
          "imageBucket": "sample string 2"
        },
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "poseidonBookingId": "sample string 4",
        "programLength": "sample string 5",
        "destinationCountry": "sample string 6",
        "destinationCountryCode": "sample string 7",
        "birthCountry": "sample string 8",
        "birthCountryCode": "sample string 9",
        "countryOfCitizenship": "sample string 10",
        "salesCountry": "sample string 11",
        "salesCountryCode": "sample string 12",
        "gender": "sample string 13",
        "age": 14,
        "dateOfBirth": "2025-11-02T22:49:01.8443359Z",
        "yearOfBirth": 15,
        "openToSingleParent": "sample string 16",
        "openToDoublePlacement": "sample string 17",
        "openToLGBTQ": "sample string 18",
        "openToPets": "sample string 19",
        "openToHostSiblings": "sample string 20",
        "openToSharingRoom": "sample string 21",
        "isCamper": true,
        "programStart": "sample string 23",
        "regionChoice": "sample string 24",
        "englishLevel": 1,
        "languageTestScore": 1,
        "livesWith": "sample string 25",
        "hasSiblings": "sample string 26",
        "numberOfSiblings": "sample string 27",
        "siblingAges": "sample string 28",
        "hasPets": "sample string 29",
        "pets": "sample string 30",
        "religion": "sample string 31",
        "religionFrequency": "sample string 32",
        "attendHostReligion": "sample string 33",
        "gradeAverage": "sample string 34",
        "graduationYear": "sample string 35",
        "allergies": "sample string 36",
        "foodRestrictions": "sample string 37",
        "epiPen": "sample string 38",
        "interviewComments": "sample string 39",
        "aboutYourself": "sample string 40",
        "chooseThreeThings": "sample string 41",
        "wantToTry": "sample string 42",
        "hobbiesAndInterests": "sample string 43",
        "describeYourself": "sample string 44",
        "passionateAbout": "sample string 45",
        "favoriteClasses": "sample string 46",
        "tellMoreAboutInterests": "sample string 47",
        "spendFreeTime": "sample string 48",
        "hostFamilyLetter": "sample string 49",
        "sports": [
          {
            "name": "sample string 1",
            "frequency": "sample string 2",
            "teamOrFun": "sample string 3"
          },
          {
            "name": "sample string 1",
            "frequency": "sample string 2",
            "teamOrFun": "sample string 3"
          }
        ],
        "music": [
          {
            "name": "sample string 1",
            "timePlaying": "sample string 2"
          },
          {
            "name": "sample string 1",
            "timePlaying": "sample string 2"
          }
        ],
        "musicTimePlaying": "sample string 50",
        "tv": "sample string 51",
        "movies": "sample string 52",
        "foods": "sample string 53",
        "saturdayNightActivities": "sample string 54",
        "talkativeOrQuiet": "sample string 55",
        "outgoingOrShy": "sample string 56",
        "messyOrOrganized": "sample string 57",
        "flexibleOrRigid": "sample string 58",
        "hasStateChoices": true,
        "stateChoices": "sample string 60",
        "whyStudyAbroad": "sample string 61",
        "whySuccessfulStudent": "sample string 62",
        "favoriteActivities": "sample string 63",
        "goalsInLife": "sample string 64"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<StudentResponseOfStudentPDFCatalogViewModeltQA_S5cky xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/HSEY.ViewModel.Search">
    <d2p1:CatalogName>sample string 1</d2p1:CatalogName>
    <d2p1:DashUrl>sample string 2</d2p1:DashUrl>
    <d2p1:IsFieldFriendly>true</d2p1:IsFieldFriendly>
    <d2p1:Students>
      <d2p1:StudentPDFViewModel>
        <d2p1:AboutYourself>sample string 40</d2p1:AboutYourself>
        <d2p1:Age>14</d2p1:Age>
        <d2p1:Allergies>sample string 36</d2p1:Allergies>
        <d2p1:AttendHostReligion>sample string 33</d2p1:AttendHostReligion>
        <d2p1:BirthCountry>sample string 8</d2p1:BirthCountry>
        <d2p1:BirthCountryCode>sample string 9</d2p1:BirthCountryCode>
        <d2p1:ChooseThreeThings>sample string 41</d2p1:ChooseThreeThings>
        <d2p1:CountryOfCitizenship>sample string 10</d2p1:CountryOfCitizenship>
        <d2p1:DateOfBirth>2025-11-02T22:49:01.8443359+00:00</d2p1:DateOfBirth>
        <d2p1:DescribeYourself>sample string 44</d2p1:DescribeYourself>
        <d2p1:DestinationCountry>sample string 6</d2p1:DestinationCountry>
        <d2p1:DestinationCountryCode>sample string 7</d2p1:DestinationCountryCode>
        <d2p1:EnglishLevel>1</d2p1:EnglishLevel>
        <d2p1:EpiPen>sample string 38</d2p1:EpiPen>
        <d2p1:FavoriteActivities>sample string 63</d2p1:FavoriteActivities>
        <d2p1:FavoriteClasses>sample string 46</d2p1:FavoriteClasses>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:FlexibleOrRigid>sample string 58</d2p1:FlexibleOrRigid>
        <d2p1:FoodRestrictions>sample string 37</d2p1:FoodRestrictions>
        <d2p1:Foods>sample string 53</d2p1:Foods>
        <d2p1:Gender>sample string 13</d2p1:Gender>
        <d2p1:GoalsInLife>sample string 64</d2p1:GoalsInLife>
        <d2p1:GradeAverage>sample string 34</d2p1:GradeAverage>
        <d2p1:GraduationYear>sample string 35</d2p1:GraduationYear>
        <d2p1:HasPets>sample string 29</d2p1:HasPets>
        <d2p1:HasSiblings>sample string 26</d2p1:HasSiblings>
        <d2p1:HasStateChoices>true</d2p1:HasStateChoices>
        <d2p1:HobbiesAndInterests>sample string 43</d2p1:HobbiesAndInterests>
        <d2p1:HostFamilyLetter>sample string 49</d2p1:HostFamilyLetter>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:ImageData>
          <d2p1:ImageBucket>sample string 2</d2p1:ImageBucket>
          <d2p1:ImageKey>sample string 1</d2p1:ImageKey>
        </d2p1:ImageData>
        <d2p1:InterviewComments>sample string 39</d2p1:InterviewComments>
        <d2p1:IsCamper>true</d2p1:IsCamper>
        <d2p1:LanguageTestScore>1</d2p1:LanguageTestScore>
        <d2p1:LastName>sample string 3</d2p1:LastName>
        <d2p1:LivesWith>sample string 25</d2p1:LivesWith>
        <d2p1:MessyOrOrganized>sample string 57</d2p1:MessyOrOrganized>
        <d2p1:Movies>sample string 52</d2p1:Movies>
        <d2p1:Music>
          <d2p1:Music>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TimePlaying>sample string 2</d2p1:TimePlaying>
          </d2p1:Music>
          <d2p1:Music>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TimePlaying>sample string 2</d2p1:TimePlaying>
          </d2p1:Music>
        </d2p1:Music>
        <d2p1:MusicTimePlaying>sample string 50</d2p1:MusicTimePlaying>
        <d2p1:NumberOfSiblings>sample string 27</d2p1:NumberOfSiblings>
        <d2p1:OpenToDoublePlacement>sample string 17</d2p1:OpenToDoublePlacement>
        <d2p1:OpenToHostSiblings>sample string 20</d2p1:OpenToHostSiblings>
        <d2p1:OpenToLGBTQ>sample string 18</d2p1:OpenToLGBTQ>
        <d2p1:OpenToPets>sample string 19</d2p1:OpenToPets>
        <d2p1:OpenToSharingRoom>sample string 21</d2p1:OpenToSharingRoom>
        <d2p1:OpenToSingleParent>sample string 16</d2p1:OpenToSingleParent>
        <d2p1:OutgoingOrShy>sample string 56</d2p1:OutgoingOrShy>
        <d2p1:PassionateAbout>sample string 45</d2p1:PassionateAbout>
        <d2p1:Pets>sample string 30</d2p1:Pets>
        <d2p1:PoseidonBookingId>sample string 4</d2p1:PoseidonBookingId>
        <d2p1:ProgramLength>sample string 5</d2p1:ProgramLength>
        <d2p1:ProgramStart>sample string 23</d2p1:ProgramStart>
        <d2p1:RegionChoice>sample string 24</d2p1:RegionChoice>
        <d2p1:Religion>sample string 31</d2p1:Religion>
        <d2p1:ReligionFrequency>sample string 32</d2p1:ReligionFrequency>
        <d2p1:SalesCountry>sample string 11</d2p1:SalesCountry>
        <d2p1:SalesCountryCode>sample string 12</d2p1:SalesCountryCode>
        <d2p1:SaturdayNightActivities>sample string 54</d2p1:SaturdayNightActivities>
        <d2p1:SiblingAges>sample string 28</d2p1:SiblingAges>
        <d2p1:SpendFreeTime>sample string 48</d2p1:SpendFreeTime>
        <d2p1:Sports>
          <d2p1:Sport>
            <d2p1:Frequency>sample string 2</d2p1:Frequency>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TeamOrFun>sample string 3</d2p1:TeamOrFun>
          </d2p1:Sport>
          <d2p1:Sport>
            <d2p1:Frequency>sample string 2</d2p1:Frequency>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TeamOrFun>sample string 3</d2p1:TeamOrFun>
          </d2p1:Sport>
        </d2p1:Sports>
        <d2p1:StateChoices>sample string 60</d2p1:StateChoices>
        <d2p1:TV>sample string 51</d2p1:TV>
        <d2p1:TalkativeOrQuiet>sample string 55</d2p1:TalkativeOrQuiet>
        <d2p1:TellMoreAboutInterests>sample string 47</d2p1:TellMoreAboutInterests>
        <d2p1:WantToTry>sample string 42</d2p1:WantToTry>
        <d2p1:WhyStudyAbroad>sample string 61</d2p1:WhyStudyAbroad>
        <d2p1:WhySuccessfulStudent>sample string 62</d2p1:WhySuccessfulStudent>
        <d2p1:YearOfBirth>15</d2p1:YearOfBirth>
      </d2p1:StudentPDFViewModel>
      <d2p1:StudentPDFViewModel>
        <d2p1:AboutYourself>sample string 40</d2p1:AboutYourself>
        <d2p1:Age>14</d2p1:Age>
        <d2p1:Allergies>sample string 36</d2p1:Allergies>
        <d2p1:AttendHostReligion>sample string 33</d2p1:AttendHostReligion>
        <d2p1:BirthCountry>sample string 8</d2p1:BirthCountry>
        <d2p1:BirthCountryCode>sample string 9</d2p1:BirthCountryCode>
        <d2p1:ChooseThreeThings>sample string 41</d2p1:ChooseThreeThings>
        <d2p1:CountryOfCitizenship>sample string 10</d2p1:CountryOfCitizenship>
        <d2p1:DateOfBirth>2025-11-02T22:49:01.8443359+00:00</d2p1:DateOfBirth>
        <d2p1:DescribeYourself>sample string 44</d2p1:DescribeYourself>
        <d2p1:DestinationCountry>sample string 6</d2p1:DestinationCountry>
        <d2p1:DestinationCountryCode>sample string 7</d2p1:DestinationCountryCode>
        <d2p1:EnglishLevel>1</d2p1:EnglishLevel>
        <d2p1:EpiPen>sample string 38</d2p1:EpiPen>
        <d2p1:FavoriteActivities>sample string 63</d2p1:FavoriteActivities>
        <d2p1:FavoriteClasses>sample string 46</d2p1:FavoriteClasses>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:FlexibleOrRigid>sample string 58</d2p1:FlexibleOrRigid>
        <d2p1:FoodRestrictions>sample string 37</d2p1:FoodRestrictions>
        <d2p1:Foods>sample string 53</d2p1:Foods>
        <d2p1:Gender>sample string 13</d2p1:Gender>
        <d2p1:GoalsInLife>sample string 64</d2p1:GoalsInLife>
        <d2p1:GradeAverage>sample string 34</d2p1:GradeAverage>
        <d2p1:GraduationYear>sample string 35</d2p1:GraduationYear>
        <d2p1:HasPets>sample string 29</d2p1:HasPets>
        <d2p1:HasSiblings>sample string 26</d2p1:HasSiblings>
        <d2p1:HasStateChoices>true</d2p1:HasStateChoices>
        <d2p1:HobbiesAndInterests>sample string 43</d2p1:HobbiesAndInterests>
        <d2p1:HostFamilyLetter>sample string 49</d2p1:HostFamilyLetter>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:ImageData>
          <d2p1:ImageBucket>sample string 2</d2p1:ImageBucket>
          <d2p1:ImageKey>sample string 1</d2p1:ImageKey>
        </d2p1:ImageData>
        <d2p1:InterviewComments>sample string 39</d2p1:InterviewComments>
        <d2p1:IsCamper>true</d2p1:IsCamper>
        <d2p1:LanguageTestScore>1</d2p1:LanguageTestScore>
        <d2p1:LastName>sample string 3</d2p1:LastName>
        <d2p1:LivesWith>sample string 25</d2p1:LivesWith>
        <d2p1:MessyOrOrganized>sample string 57</d2p1:MessyOrOrganized>
        <d2p1:Movies>sample string 52</d2p1:Movies>
        <d2p1:Music>
          <d2p1:Music>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TimePlaying>sample string 2</d2p1:TimePlaying>
          </d2p1:Music>
          <d2p1:Music>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TimePlaying>sample string 2</d2p1:TimePlaying>
          </d2p1:Music>
        </d2p1:Music>
        <d2p1:MusicTimePlaying>sample string 50</d2p1:MusicTimePlaying>
        <d2p1:NumberOfSiblings>sample string 27</d2p1:NumberOfSiblings>
        <d2p1:OpenToDoublePlacement>sample string 17</d2p1:OpenToDoublePlacement>
        <d2p1:OpenToHostSiblings>sample string 20</d2p1:OpenToHostSiblings>
        <d2p1:OpenToLGBTQ>sample string 18</d2p1:OpenToLGBTQ>
        <d2p1:OpenToPets>sample string 19</d2p1:OpenToPets>
        <d2p1:OpenToSharingRoom>sample string 21</d2p1:OpenToSharingRoom>
        <d2p1:OpenToSingleParent>sample string 16</d2p1:OpenToSingleParent>
        <d2p1:OutgoingOrShy>sample string 56</d2p1:OutgoingOrShy>
        <d2p1:PassionateAbout>sample string 45</d2p1:PassionateAbout>
        <d2p1:Pets>sample string 30</d2p1:Pets>
        <d2p1:PoseidonBookingId>sample string 4</d2p1:PoseidonBookingId>
        <d2p1:ProgramLength>sample string 5</d2p1:ProgramLength>
        <d2p1:ProgramStart>sample string 23</d2p1:ProgramStart>
        <d2p1:RegionChoice>sample string 24</d2p1:RegionChoice>
        <d2p1:Religion>sample string 31</d2p1:Religion>
        <d2p1:ReligionFrequency>sample string 32</d2p1:ReligionFrequency>
        <d2p1:SalesCountry>sample string 11</d2p1:SalesCountry>
        <d2p1:SalesCountryCode>sample string 12</d2p1:SalesCountryCode>
        <d2p1:SaturdayNightActivities>sample string 54</d2p1:SaturdayNightActivities>
        <d2p1:SiblingAges>sample string 28</d2p1:SiblingAges>
        <d2p1:SpendFreeTime>sample string 48</d2p1:SpendFreeTime>
        <d2p1:Sports>
          <d2p1:Sport>
            <d2p1:Frequency>sample string 2</d2p1:Frequency>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TeamOrFun>sample string 3</d2p1:TeamOrFun>
          </d2p1:Sport>
          <d2p1:Sport>
            <d2p1:Frequency>sample string 2</d2p1:Frequency>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:TeamOrFun>sample string 3</d2p1:TeamOrFun>
          </d2p1:Sport>
        </d2p1:Sports>
        <d2p1:StateChoices>sample string 60</d2p1:StateChoices>
        <d2p1:TV>sample string 51</d2p1:TV>
        <d2p1:TalkativeOrQuiet>sample string 55</d2p1:TalkativeOrQuiet>
        <d2p1:TellMoreAboutInterests>sample string 47</d2p1:TellMoreAboutInterests>
        <d2p1:WantToTry>sample string 42</d2p1:WantToTry>
        <d2p1:WhyStudyAbroad>sample string 61</d2p1:WhyStudyAbroad>
        <d2p1:WhySuccessfulStudent>sample string 62</d2p1:WhySuccessfulStudent>
        <d2p1:YearOfBirth>15</d2p1:YearOfBirth>
      </d2p1:StudentPDFViewModel>
    </d2p1:Students>
  </Data>
  <Message>sample string 1</Message>
</StudentResponseOfStudentPDFCatalogViewModeltQA_S5cky>