regis

<back to all web services

TermStatementRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TermStatements/{uuid}/{reporting_term}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class TermStatementRequest
            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class TermStatementChargesResponse
            Public Overridable Property date As Date
            Public Overridable Property code As String
            Public Overridable Property description As String
            Public Overridable Property is_financial_aid As Boolean
            Public Overridable Property charge As Decimal
        End Class

        Public Partial Class TermStatementRegistrationResponse
            Public Overridable Property course_name As String
            Public Overridable Property title As String
            Public Overridable Property section_code As String
            Public Overridable Property amount As Decimal
            Public Overridable Property is_audit As Boolean
            Public Overridable Property meeting_days As String
            Public Overridable Property times As String
            Public Overridable Property room As String
            Public Overridable Property instructor As String
            Public Overridable Property status As String
            Public Overridable Property cost As Decimal
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
        End Class

        Public Partial Class TermStatementResponse
            Public Sub New()
                registrations = New List(Of TermStatementRegistrationResponse)
                charges = New List(Of TermStatementChargesResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property name As String
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property code As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_term_start_date As Date
            Public Overridable Property reporting_term_end_date As Date
            Public Overridable Property academic_program As String
            Public Overridable Property total_term_payments As Decimal
            Public Overridable Property total_term_charges As Decimal
            Public Overridable Property total_term_taxes As Decimal
            Public Overridable Property registrations As List(Of TermStatementRegistrationResponse)
            Public Overridable Property charges As List(Of TermStatementChargesResponse)
        End Class
    End Namespace
End Namespace

VB.NET TermStatementRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /TermStatements/{uuid}/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","reporting_term":"String","reporting_term_start_date":"0001-01-01T00:00:00.0000000","reporting_term_end_date":"0001-01-01T00:00:00.0000000","academic_program":"String","total_term_payments":0,"total_term_charges":0,"total_term_taxes":0,"registrations":[{"course_name":"String","title":"String","section_code":"String","amount":0,"is_audit":false,"meeting_days":"String","times":"String","room":"String","instructor":"String","status":"String","cost":0,"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}],"charges":[{"date":"0001-01-01T00:00:00.0000000","code":"String","description":"String","is_financial_aid":false,"charge":0}]}