Reference for https://tsapi.southhills.edu/Academics/students/{STUDENTNUMBER}/enrollments/
Creates an enrollment record for a student.
Url: https://tsapi.southhills.edu/Academics/students/{STUDENTNUMBER}/enrollments/
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<CreateProgramEnrollmentRequest xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract.Requests">
<ProgramEnrollment>
<AttendanceMode xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</AttendanceMode>
<CohortGroup xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</CohortGroup>
<DateofDetermination xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</DateofDetermination>
<DeliveryMode xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</DeliveryMode>
<EnrollmentDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</EnrollmentDate>
<ExpectedCompletionDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</ExpectedCompletionDate>
<FeeCategory xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</FeeCategory>
<FloatingTermGroupCode xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</FloatingTermGroupCode>
<KeyProgramFlag xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">true</KeyProgramFlag>
<OriginalStartDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</OriginalStartDate>
<ProgramCode xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</ProgramCode>
<ProgramEnrollmentId xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">2147483647</ProgramEnrollmentId>
<ProgramEnrollmentStartDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</ProgramEnrollmentStartDate>
<ProgramStatus xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</ProgramStatus>
<ReenrollmentDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</ReenrollmentDate>
<Session xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</Session>
<StartTerm xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</StartTerm>
<StudentNumber xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</StudentNumber>
<SubProgram xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</SubProgram>
<SubProgramCompletionDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</SubProgramCompletionDate>
<SubProgramStartDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</SubProgramStartDate>
<SubProgramStatus xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">String content</SubProgramStatus>
<TransferStudentIdentifier xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">true</TransferStudentIdentifier>
<WithdrawalDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract">1999-05-31T11:20:00</WithdrawalDate>
</ProgramEnrollment>
</CreateProgramEnrollmentRequest>
The following is an example request Json body:
{
"ProgramEnrollment":{
"AttendanceMode":"String content",
"CohortGroup":"String content",
"DateofDetermination":"\/Date(928164000000-0400)\/",
"DeliveryMode":"String content",
"EnrollmentDate":"\/Date(928164000000-0400)\/",
"ExpectedCompletionDate":"\/Date(928164000000-0400)\/",
"FeeCategory":"String content",
"FloatingTermGroupCode":"String content",
"KeyProgramFlag":true,
"OriginalStartDate":"\/Date(928164000000-0400)\/",
"ProgramCode":"String content",
"ProgramEnrollmentId":2147483647,
"ProgramEnrollmentStartDate":"\/Date(928164000000-0400)\/",
"ProgramStatus":"String content",
"ReenrollmentDate":"\/Date(928164000000-0400)\/",
"Session":"String content",
"StartTerm":"String content",
"StudentNumber":"String content",
"SubProgram":"String content",
"SubProgramCompletionDate":"\/Date(928164000000-0400)\/",
"SubProgramStartDate":"\/Date(928164000000-0400)\/",
"SubProgramStatus":"String content",
"TransferStudentIdentifier":true,
"WithdrawalDate":"\/Date(928164000000-0400)\/"
}
}
The following is an example response Xml body:
<CreateProgramEnrollmentResponse 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>
<ProgramCode>String content</ProgramCode>
<ProgramEnrollmentId>2147483647</ProgramEnrollmentId>
<StudentNumber>String content</StudentNumber>
</CreateProgramEnrollmentResponse>
The following is an example response Json body:
{
"Messages":[{
"Code":"String content",
"Message":"String content",
"Scope":0,
"Type":0
}],
"Status":0,
"ProgramCode":"String content",
"ProgramEnrollmentId":2147483647,
"StudentNumber":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract.Requests" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract.Requests" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract" />
<xs:complexType name="CreateProgramEnrollmentRequest">
<xs:sequence>
<xs:element minOccurs="0" name="ProgramEnrollment" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/TopSchool.Academics.TopX.Contract" type="q1:ProgramEnrollment" />
</xs:sequence>
</xs:complexType>
<xs:element name="CreateProgramEnrollmentRequest" nillable="true" type="tns:CreateProgramEnrollmentRequest" />
</xs:schema>
Additional request 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/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="ProgramEnrollment">
<xs:sequence>
<xs:element minOccurs="0" name="AttendanceMode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CohortGroup" nillable="true" type="xs:string" />
<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" nillable="true" type="xs:dateTime" />
<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="KeyProgramFlag" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="OriginalStartDate" nillable="true" type="xs:dateTime" />
<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="ProgramEnrollmentStartDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="ProgramStatus" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ReenrollmentDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="Session" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StartTerm" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StudentNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SubProgram" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SubProgramCompletionDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="SubProgramStartDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="SubProgramStatus" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TransferStudentIdentifier" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="WithdrawalDate" nillable="true" type="xs:dateTime" />
</xs:sequence>
</xs:complexType>
<xs:element name="ProgramEnrollment" nillable="true" type="tns:ProgramEnrollment" />
</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>
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/TSSystem" />
<xs:complexType name="CreateProgramEnrollmentResponse">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/TSSystem" base="q1:ResponseBase">
<xs:sequence>
<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="StudentNumber" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CreateProgramEnrollmentResponse" nillable="true" type="tns:CreateProgramEnrollmentResponse" />
</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="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>
<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>