GET api/student/details/{PoseidonBookingId}

Returns basic information about a student. This includes birthdate, country code, email, first- and lastname, home address, and phone numbers. If no student details are found it will return 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

Basic student information

StudentResponseOfStudentDetails
NameDescriptionTypeAdditional information
Message

string

None.
HasError

boolean

None.
Data

StudentDetails

None.

Response Formats

application/json, text/json

Sample: 
{
  "message": "sample string 1",
  "hasError": true,
  "data": {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "email": "sample string 3",
    "mainPhone": "sample string 4",
    "mobilePhone": "sample string 5",
    "countryCode": "sample string 6",
    "birthDate": "2025-05-20",
    "homeAddress": {
      "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"
    }
  }
}

application/xml, text/xml

Sample: 
<StudentResponseOfStudentDetailsK6lwLlVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <Data>
    <BirthDateValue>2025-05-20T18:37:19.6963963+00:00</BirthDateValue>
    <CountryCode>sample string 6</CountryCode>
    <Email>sample string 3</Email>
    <FirstName>sample string 1</FirstName>
    <HomeAddress>
      <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>
    </HomeAddress>
    <LastName>sample string 2</LastName>
    <MainPhone>sample string 4</MainPhone>
    <MobilePhone>sample string 5</MobilePhone>
  </Data>
  <Message>sample string 1</Message>
</StudentResponseOfStudentDetailsK6lwLlVo>