Reference for https://tsapi.southhills.edu/Finance/transactions/{STUDENTNUMBER}?transactionType={TRANSTYPE}&utcStartDate={UTCSTARTDATE}&utcEndDate={UTCENDDATE}&pageIndex={PAGEINDEX}&pageSize={PAGESIZE}
Retrieves transactions by student, TransactionType, As of DateTime (UTC), Page Size and Index are optional.
Url: https://tsapi.southhills.edu/Finance/transactions/{STUDENTNUMBER}?transactionType={TRANSTYPE}&utcStartDate={UTCSTARTDATE}&utcEndDate={UTCENDDATE}&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:
<StudentFinancialTransactionResponse xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Finance.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>
<StudentFirstName>String content</StudentFirstName>
<StudentLastName>String content</StudentLastName>
<StudentNumber>String content</StudentNumber>
<Transactions>
<StudentFinancialTransaction xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract">
<AccountingType>String content</AccountingType>
<Amount>12678967.543233</Amount>
<Balance>12678967.543233</Balance>
<CheckNumber>String content</CheckNumber>
<Course>String content</Course>
<CreatedBy>String content</CreatedBy>
<CreatedDate>1999-05-31T11:20:00</CreatedDate>
<CreditCardApprovalCode>String content</CreditCardApprovalCode>
<Currency>String content</Currency>
<Description>String content</Description>
<EffectiveAmount>12678967.543233</EffectiveAmount>
<EffectiveDate>1999-05-31T11:20:00</EffectiveDate>
<ExternalId>String content</ExternalId>
<Note>String content</Note>
<Program>String content</Program>
<Term>String content</Term>
<TransactionEid>String content</TransactionEid>
<TransactionType>String content</TransactionType>
</StudentFinancialTransaction>
<StudentFinancialTransaction xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract">
<AccountingType>String content</AccountingType>
<Amount>12678967.543233</Amount>
<Balance>12678967.543233</Balance>
<CheckNumber>String content</CheckNumber>
<Course>String content</Course>
<CreatedBy>String content</CreatedBy>
<CreatedDate>1999-05-31T11:20:00</CreatedDate>
<CreditCardApprovalCode>String content</CreditCardApprovalCode>
<Currency>String content</Currency>
<Description>String content</Description>
<EffectiveAmount>12678967.543233</EffectiveAmount>
<EffectiveDate>1999-05-31T11:20:00</EffectiveDate>
<ExternalId>String content</ExternalId>
<Note>String content</Note>
<Program>String content</Program>
<Term>String content</Term>
<TransactionEid>String content</TransactionEid>
<TransactionType>String content</TransactionType>
</StudentFinancialTransaction>
</Transactions>
</StudentFinancialTransactionResponse>
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,
"StudentFirstName":"String content",
"StudentLastName":"String content",
"StudentNumber":"String content",
"Transactions":[{
"AccountingType":"String content",
"Amount":12678967.543233,
"Balance":12678967.543233,
"CheckNumber":"String content",
"Course":"String content",
"CreatedBy":"String content",
"CreatedDate":"\/Date(928164000000-0400)\/",
"CreditCardApprovalCode":"String content",
"Currency":"String content",
"Description":"String content",
"EffectiveAmount":12678967.543233,
"EffectiveDate":"\/Date(928164000000-0400)\/",
"ExternalId":"String content",
"Note":"String content",
"Program":"String content",
"Term":"String content",
"TransactionEid":"String content",
"TransactionType":"String content"
}]
}
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract.Responses" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract.Responses" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/TSSystem" />
<xs:complexType name="StudentFinancialTransactionResponse">
<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="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="Transactions" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract" type="q2:ArrayOfStudentFinancialTransaction" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="StudentFinancialTransactionResponse" nillable="true" type="tns:StudentFinancialTransactionResponse" />
</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.Finance.TopX.Contract" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Finance.TopX.Contract" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfStudentFinancialTransaction">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="StudentFinancialTransaction" nillable="true" type="tns:StudentFinancialTransaction" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfStudentFinancialTransaction" nillable="true" type="tns:ArrayOfStudentFinancialTransaction" />
<xs:complexType name="StudentFinancialTransaction">
<xs:sequence>
<xs:element minOccurs="0" name="AccountingType" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Amount" nillable="true" type="xs:decimal" />
<xs:element minOccurs="0" name="Balance" nillable="true" type="xs:decimal" />
<xs:element minOccurs="0" name="CheckNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Course" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CreatedBy" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CreatedDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="CreditCardApprovalCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Currency" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EffectiveAmount" nillable="true" type="xs:decimal" />
<xs:element minOccurs="0" name="EffectiveDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="ExternalId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Note" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Program" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Term" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TransactionEid" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TransactionType" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="StudentFinancialTransaction" nillable="true" type="tns:StudentFinancialTransaction" />
</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>