GET api/student/commute/{PoseidonBookingId}

Returns the host family and school address (if any) for the selected student, if the student is currently placed. Needs the Poseidon booking number in order to determinte which student program, host family, and school should be used. If the student is not placed, or a matching booking cannot be found it returns an empty response with a message.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PoseidonBookingId

The Poseidon booking ID.

 string

Required

String length: inclusive between 6 and 32
poseidonBookingId

string

None.

Body Parameters

None.

Response Information

Resource Description

The street addresses of the host family and the school

StudentResponseOfStudentCommute
NameDescriptionTypeAdditional information
Message

string

None.
HasError

boolean

None.
Data

StudentCommute

None.

Response Formats

application/json, text/json

Sample: 
{
  "message": "sample string 1",
  "hasError": true,
  "data": {
    "hostFamilyAddress": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "address3": "sample string 3",
      "postalCode": "sample string 4",
      "city": "sample string 5",
      "state": "sample string 6",
      "countryCode": "sample string 7"
    },
    "hostFamilyName": "sample string 1",
    "schoolAddress": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "address3": "sample string 3",
      "postalCode": "sample string 4",
      "city": "sample string 5",
      "state": "sample string 6",
      "countryCode": "sample string 7"
    },
    "schoolName": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<StudentResponseOfStudentCommuteK6lwLlVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Data>
    <HostFamilyAddress>
      <Address1>sample string 1</Address1>
      <Address2>sample string 2</Address2>
      <Address3>sample string 3</Address3>
      <City>sample string 5</City>
      <CountryCode>sample string 7</CountryCode>
      <PostalCode>sample string 4</PostalCode>
      <State>sample string 6</State>
    </HostFamilyAddress>
    <HostFamilyName>sample string 1</HostFamilyName>
    <SchoolAddress>
      <Address1>sample string 1</Address1>
      <Address2>sample string 2</Address2>
      <Address3>sample string 3</Address3>
      <City>sample string 5</City>
      <CountryCode>sample string 7</CountryCode>
      <PostalCode>sample string 4</PostalCode>
      <State>sample string 6</State>
    </SchoolAddress>
    <SchoolName>sample string 2</SchoolName>
  </Data>
  <Message>sample string 1</Message>
</StudentResponseOfStudentCommuteK6lwLlVo>