Reference for https://tsapi.southhills.edu/Academics/enrollments/{PROGRAMSTATUS}?programCode={PROGRAMCODE}&attendanceType={ATTENDANCETYPE}&deliveryMode={DELIVERYMODE}&startTerm={STARTTERM}&pageIndex={PAGEINDEX}&pageSize={PAGESIZE}
Retrieves enrollment records for a student.
Url: https://tsapi.southhills.edu/Academics/enrollments/{PROGRAMSTATUS}?programCode={PROGRAMCODE}&attendanceType={ATTENDANCETYPE}&deliveryMode={DELIVERYMODE}&startTerm={STARTTERM}&pageIndex={PAGEINDEX}&pageSize={PAGESIZE}
HTTP Method: GET
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<GetStudentEnrollmentsResponse xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract.Responses">
<Messages xmlns="http://schemas.datacontract.org/2004/07/TSSystem">
<RuntimeMessage>
<Code>String content</Code>
<Message>String content</Message>
<Scope>Undefined</Scope>
<Type>Exception</Type>
</RuntimeMessage>
<RuntimeMessage>
<Code>String content</Code>
<Message>String content</Message>
<Scope>Undefined</Scope>
<Type>Exception</Type>
</RuntimeMessage>
</Messages>
<Status xmlns="http://schemas.datacontract.org/2004/07/TSSystem">Undefined</Status>
<PageIndex xmlns="http://schemas.datacontract.org/2004/07/TSSystem">2147483647</PageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/TSSystem">2147483647</PageSize>
<Total xmlns="http://schemas.datacontract.org/2004/07/TSSystem">2147483647</Total>
<StudentEnrollments>
<StudentEnrollment xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">
<AttendanceType>String content</AttendanceType>
<Cohort>String content</Cohort>
<CompletionDate>1999-05-31T11:20:00</CompletionDate>
<ConferalDate>1999-05-31T11:20:00</ConferalDate>
<DateOfDetermination>1999-05-31T11:20:00</DateOfDetermination>
<DeliveryMode>String content</DeliveryMode>
<EnrollmentDate>1999-05-31T11:20:00</EnrollmentDate>
<EnrollmentStatusReasonCode>String content</EnrollmentStatusReasonCode>
<ExpectedCompletionDate>1999-05-31T11:20:00</ExpectedCompletionDate>
<FeeCategory>String content</FeeCategory>
<FloatingTermGroupCode>String content</FloatingTermGroupCode>
<GraduationStatus>String content</GraduationStatus>
<KeyProgramIndicator>true</KeyProgramIndicator>
<LastDateofAttendance>1999-05-31T11:20:00</LastDateofAttendance>
<MidPointDate>1999-05-31T11:20:00</MidPointDate>
<OriginalStartDate>1999-05-31T11:20:00</OriginalStartDate>
<PrimaryEmail>String content</PrimaryEmail>
<ProgramCode>String content</ProgramCode>
<ProgramEnrollmentId>2147483647</ProgramEnrollmentId>
<ProgramEnrollmentStatus>String content</ProgramEnrollmentStatus>
<ProgramName>String content</ProgramName>
<ProgramVersion>String content</ProgramVersion>
<ReentryDate>1999-05-31T11:20:00</ReentryDate>
<StartDate>1999-05-31T11:20:00</StartDate>
<StartTerm>String content</StartTerm>
<StudentFirstName>String content</StudentFirstName>
<StudentLastName>String content</StudentLastName>
<StudentNumber>String content</StudentNumber>
<TransferStudentIndicator>true</TransferStudentIndicator>
<WithdrawalDate>1999-05-31T11:20:00</WithdrawalDate>
</StudentEnrollment>
<StudentEnrollment xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">
<AttendanceType>String content</AttendanceType>
<Cohort>String content</Cohort>
<CompletionDate>1999-05-31T11:20:00</CompletionDate>
<ConferalDate>1999-05-31T11:20:00</ConferalDate>
<DateOfDetermination>1999-05-31T11:20:00</DateOfDetermination>
<DeliveryMode>String content</DeliveryMode>
<EnrollmentDate>1999-05-31T11:20:00</EnrollmentDate>
<EnrollmentStatusReasonCode>String content</EnrollmentStatusReasonCode>
<ExpectedCompletionDate>1999-05-31T11:20:00</ExpectedCompletionDate>
<FeeCategory>String content</FeeCategory>
<FloatingTermGroupCode>String content</FloatingTermGroupCode>
<GraduationStatus>String content</GraduationStatus>
<KeyProgramIndicator>true</KeyProgramIndicator>
<LastDateofAttendance>1999-05-31T11:20:00</LastDateofAttendance>
<MidPointDate>1999-05-31T11:20:00</MidPointDate>
<OriginalStartDate>1999-05-31T11:20:00</OriginalStartDate>
<PrimaryEmail>String content</PrimaryEmail>
<ProgramCode>String content</ProgramCode>
<ProgramEnrollmentId>2147483647</ProgramEnrollmentId>
<ProgramEnrollmentStatus>String content</ProgramEnrollmentStatus>
<ProgramName>String content</ProgramName>
<ProgramVersion>String content</ProgramVersion>
<ReentryDate>1999-05-31T11:20:00</ReentryDate>
<StartDate>1999-05-31T11:20:00</StartDate>
<StartTerm>String content</StartTerm>
<StudentFirstName>String content</StudentFirstName>
<StudentLastName>String content</StudentLastName>
<StudentNumber>String content</StudentNumber>
<TransferStudentIndicator>true</TransferStudentIndicator>
<WithdrawalDate>1999-05-31T11:20:00</WithdrawalDate>
</StudentEnrollment>
</StudentEnrollments>
</GetStudentEnrollmentsResponse>
The following is an example response Json body:
{
"Messages":[{
"Code":"String content",
"Message":"String content",
"Scope":0,
"Type":0
}],
"Status":0,
"PageIndex":2147483647,
"PageSize":2147483647,
"Total":2147483647,
"StudentEnrollments":[{
"AttendanceType":"String content",
"Cohort":"String content",
"CompletionDate":"\/Date(928164000000-0400)\/",
"ConferalDate":"\/Date(928164000000-0400)\/",
"DateOfDetermination":"\/Date(928164000000-0400)\/",
"DeliveryMode":"String content",
"EnrollmentDate":"\/Date(928164000000-0400)\/",
"EnrollmentStatusReasonCode":"String content",
"ExpectedCompletionDate":"\/Date(928164000000-0400)\/",
"FeeCategory":"String content",
"FloatingTermGroupCode":"String content",
"GraduationStatus":"String content",
"KeyProgramIndicator":true,
"LastDateofAttendance":"\/Date(928164000000-0400)\/",
"MidPointDate":"\/Date(928164000000-0400)\/",
"OriginalStartDate":"\/Date(928164000000-0400)\/",
"PrimaryEmail":"String content",
"ProgramCode":"String content",
"ProgramEnrollmentId":2147483647,
"ProgramEnrollmentStatus":"String content",
"ProgramName":"String content",
"ProgramVersion":"String content",
"ReentryDate":"\/Date(928164000000-0400)\/",
"StartDate":"\/Date(928164000000-0400)\/",
"StartTerm":"String content",
"StudentFirstName":"String content",
"StudentLastName":"String content",
"StudentNumber":"String content",
"TransferStudentIndicator":true,
"WithdrawalDate":"\/Date(928164000000-0400)\/"
}]
}
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract.Responses" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract.Responses" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/TSSystem" />
<xs:complexType name="GetStudentEnrollmentsResponse">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/TSSystem" base="q1:ListResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="StudentEnrollments" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract" type="q2:ArrayOfStudentEnrollment" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="GetStudentEnrollmentsResponse" nillable="true" type="tns:GetStudentEnrollmentsResponse" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TSSystem" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TSSystem" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="ListResponseBase">
<xs:complexContent mixed="false">
<xs:extension base="tns:ResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="PageIndex" type="xs:int" />
<xs:element minOccurs="0" name="PageSize" type="xs:int" />
<xs:element minOccurs="0" name="Total" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="ListResponseBase" nillable="true" type="tns:ListResponseBase" />
<xs:complexType name="ResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="Messages" nillable="true" type="tns:ArrayOfRuntimeMessage" />
<xs:element minOccurs="0" name="Status" type="tns:ResponseStatus" />
</xs:sequence>
</xs:complexType>
<xs:element name="ResponseBase" nillable="true" type="tns:ResponseBase" />
<xs:complexType name="ArrayOfRuntimeMessage">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="RuntimeMessage" nillable="true" type="tns:RuntimeMessage" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfRuntimeMessage" nillable="true" type="tns:ArrayOfRuntimeMessage" />
<xs:complexType name="RuntimeMessage">
<xs:sequence>
<xs:element minOccurs="0" name="Code" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Scope" type="tns:MessageScope" />
<xs:element minOccurs="0" name="Type" type="tns:MessageType" />
</xs:sequence>
</xs:complexType>
<xs:element name="RuntimeMessage" nillable="true" type="tns:RuntimeMessage" />
<xs:simpleType name="MessageScope">
<xs:restriction base="xs:string">
<xs:enumeration value="Undefined" />
<xs:enumeration value="FriendlyError" />
<xs:enumeration value="SystemError" />
<xs:enumeration value="Warning">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Information">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="MessageScope" nillable="true" type="tns:MessageScope" />
<xs:simpleType name="MessageType">
<xs:restriction base="xs:string">
<xs:enumeration value="Exception" />
<xs:enumeration value="Runtime" />
<xs:enumeration value="Validation" />
</xs:restriction>
</xs:simpleType>
<xs:element name="MessageType" nillable="true" type="tns:MessageType" />
<xs:simpleType name="ResponseStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Undefined">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Success">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Error">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Warning">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="ResponseStatus" nillable="true" type="tns:ResponseStatus" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfStudentEnrollment">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="StudentEnrollment" nillable="true" type="tns:StudentEnrollment" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfStudentEnrollment" nillable="true" type="tns:ArrayOfStudentEnrollment" />
<xs:complexType name="StudentEnrollment">
<xs:sequence>
<xs:element minOccurs="0" name="AttendanceType" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Cohort" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CompletionDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="ConferalDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="DateOfDetermination" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="DeliveryMode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EnrollmentDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="EnrollmentStatusReasonCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ExpectedCompletionDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="FeeCategory" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FloatingTermGroupCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="GraduationStatus" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="KeyProgramIndicator" type="xs:boolean" />
<xs:element minOccurs="0" name="LastDateofAttendance" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="MidPointDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="OriginalStartDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="PrimaryEmail" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ProgramCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ProgramEnrollmentId" type="xs:int" />
<xs:element minOccurs="0" name="ProgramEnrollmentStatus" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ProgramName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ProgramVersion" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ReentryDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="StartDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="StartTerm" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StudentFirstName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StudentLastName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StudentNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TransferStudentIndicator" type="xs:boolean" />
<xs:element minOccurs="0" name="WithdrawalDate" nillable="true" type="xs:dateTime" />
</xs:sequence>
</xs:complexType>
<xs:element name="StudentEnrollment" nillable="true" type="tns:StudentEnrollment" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>