regis

<back to all web services

RegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}/{transaction_uuid}
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 RegistrationInProgressSummaryRequest
            Public Overridable Property uuid As String
            Public Overridable Property transaction_uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property online_only As Boolean
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class RegistrationDocumentResponse
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property gender As String
            Public Overridable Property email As String
            Public Overridable Property program As String
            Public Overridable Property concentration As String
            Public Overridable Property section_uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property course_title As String
            Public Overridable Property reporting_term As String
            Public Overridable Property document_code As String
            Public Overridable Property document_json As String
            Public Overridable Property document_name As String
            Public Overridable Property document_description As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class RegistrationInProgressSummaryResponse
            Public Sub New()
                requiredDocuments = New List(Of RegistrationDocumentResponse)
                completedDocuments = New List(Of RegistrationDocumentResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property transaction_uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property numberOfStudentSections As Integer
            Public Overridable Property amountOwing As Decimal
            Public Overridable Property mustPayBeforeRegistering As Boolean
            Public Overridable Property requiredDocuments As List(Of RegistrationDocumentResponse)
            Public Overridable Property completedDocuments As List(Of RegistrationDocumentResponse)
            Public Overridable Property isLate As Boolean
        End Class
    End Namespace
End Namespace

VB.NET RegistrationInProgressSummaryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Registration/InProgressSummary/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","transaction_uuid":"String","reporting_term":"String","online_only":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}