regis

<back to all web services

ProvisionalRegistrationAuthorizeRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Provisional/{student_section_uuid}/Authorize
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 ProvisionalRegistrationAuthorizeRequest
            Public Overridable Property student_section_uuid As String
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class AddRegistrationsResponse
            Inherits InvoiceResponse
            Public Sub New()
                studentSectionInvoiceItems = New List(Of StudentSectionInvoiceItemResponse)
                sectionRates = New Dictionary(Of String, List(Of SectionRateWithAmountResponse))
                messages = New List(Of String)
                availableInvoiceItems = New List(Of InvoiceItemAdminResponse)
                availableBenefits = New List(Of BenefitResponse)
            End Sub

            Public Overridable Property transaction_uuid As String
            Public Overridable Property studentSectionInvoiceItems As List(Of StudentSectionInvoiceItemResponse)
            Public Overridable Property sectionRates As Dictionary(Of String, List(Of SectionRateWithAmountResponse))
            Public Overridable Property creditTuitionRate As InvoiceItemAdminResponse
            Public Overridable Property auditTuitionRate As InvoiceItemAdminResponse
            Public Overridable Property studentAge As Nullable(Of Integer)
            Public Overridable Property studentAgeAtEarliestSectionStartDate As Nullable(Of Integer)
            Public Overridable Property isRegentGrad As Boolean
            Public Overridable Property isOnlyUnclassified As Boolean
            Public Overridable Property canRegisterForAuditInTerm As Boolean
            Public Overridable Property canRegisterForCreditInTerm As Boolean
            Public Overridable Property messages As List(Of String)
            Public Overridable Property currentTermAuditHours As Decimal
            Public Overridable Property currentTermCreditHours As Decimal
            Public Overridable Property totalCreditHours As Decimal
            Public Overridable Property availableInvoiceItems As List(Of InvoiceItemAdminResponse)
            Public Overridable Property availableBenefits As List(Of BenefitResponse)
        End Class

        Public Partial Class BenefitResponse
            Public Overridable Property rate_id As Integer
            Public Overridable Property rate_code As String
            Public Overridable Property rate_description As String
            Public Overridable Property percentage_rate As Decimal
            Public Overridable Property is_optional As Boolean
            Public Overridable Property is_required As Boolean
        End Class

        Public Partial Class DocumentResponse
            Public Overridable Property code As String
            Public Overridable Property document_name As String
            Public Overridable Property document_description As String
        End Class

        Public Partial Class InstructorResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property regent_login As String
            Public Overridable Property preferred_name As String
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property full_name As String
            Public Overridable Property email As String
            Public Overridable Property image_base64 As String
        End Class

        Public Partial Class InvoiceItemAdminResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property invoiceItemUUID As String
            Public Overridable Property rate_id As Integer
            Public Overridable Property rate_code As String
            Public Overridable Property rate_description As String
            Public Overridable Property is_required As Boolean
            Public Overridable Property is_optional As Boolean
            Public Overridable Property charge As Nullable(Of Decimal)
            Public Overridable Property credit As Nullable(Of Decimal)
        End Class

        Public Partial Class InvoiceItemResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property invoiceItemUUID As String
            Public Overridable Property rate_id As Integer
            Public Overridable Property rate_code As String
            Public Overridable Property rate_description As String
            Public Overridable Property charge As Nullable(Of Decimal)
            Public Overridable Property credit As Nullable(Of Decimal)
        End Class

        Public Partial Class InvoiceResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property invoiceUUID 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 total_charges As Nullable(Of Decimal)
            Public Overridable Property total_credits As Nullable(Of Decimal)
            Public Overridable Property current_status As String
            Public Overridable Property timestamp As Date
        End Class

        Public Partial Class SectionResponse
            Public Sub New()
                instructors = New List(Of InstructorResponse)
                required_documents = New List(Of DocumentResponse)
                start_times = New List(Of String)
                end_times = New List(Of String)
                credit_amounts = New List(Of Decimal)
                audit_amounts = New List(Of Decimal)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property secUUID As String
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property course_title As String
            Public Overridable Property course_short_title As String
            Public Overridable Property course_description As String
            Public Overridable Property crosslist_description As String
            Public Overridable Property crosslist_course_name As String
            Public Overridable Property location_long_name As String
            Public Overridable Property room As String
            Public Overridable Property instructors As List(Of InstructorResponse)
            Public Overridable Property required_documents As List(Of DocumentResponse)
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property first_meeting_date As Nullable(Of Date)
            Public Overridable Property last_meeting_date As Nullable(Of Date)
            Public Overridable Property meeting_days As String
            Public Overridable Property start_times As List(Of String)
            Public Overridable Property end_times As List(Of String)
            Public Overridable Property is_online_only As Boolean
            Public Overridable Property is_weekend As Boolean
            Public Overridable Property is_weekday As Boolean
            Public Overridable Property is_evening As Boolean
            Public Overridable Property is_waitlist As Boolean
            Public Overridable Property has_special_requirements As Boolean
            Public Overridable Property special_requirements As String
            Public Overridable Property is_unlisted As Boolean
            Public Overridable Property credit_amounts As List(Of Decimal)
            Public Overridable Property audit_amounts As List(Of Decimal)
            Public Overridable Property audits_short_name As String
            Public Overridable Property audits_long_name As String
            Public Overridable Property credits_short_name As String
            Public Overridable Property credits_long_name As String
            Public Overridable Property distance_ed_materials As String
            Public Overridable Property prerequisites As String
            Public Overridable Property corequisites As String
            Public Overridable Property capacity As Nullable(Of Integer)
            Public Overridable Property flat_fee_amount As Nullable(Of Decimal)
            Public Overridable Property additional_fee_amount As Nullable(Of Decimal)
            Public Overridable Property registered_students As Integer
            Public Overridable Property three_credit_plus As Integer
            Public Overridable Property two_credit As Integer
            Public Overridable Property one_credit As Integer
            Public Overridable Property three_audit_plus As Integer
            Public Overridable Property two_audit As Integer
            Public Overridable Property one_audit As Integer
            Public Overridable Property crosslist_registered_students As Integer
            Public Overridable Property grades_received As Integer
            Public Overridable Property crosslist_grades_received As Integer
            Public Overridable Property registration_start_date As Nullable(Of Date)
            Public Overridable Property registration_end_date As Nullable(Of Date)
            Public Overridable Property add_start_date As Nullable(Of Date)
            Public Overridable Property add_end_date As Nullable(Of Date)
            Public Overridable Property drop_start_date As Nullable(Of Date)
            Public Overridable Property drop_end_date As Nullable(Of Date)
            Public Overridable Property grading_end_date As Nullable(Of Date)
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Integer
            Public Overridable Property current_status As String
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property timestamp As Date
        End Class

        Public Partial Class StudentSectionInvoiceItemResponse
            Inherits InvoiceItemResponse
            Public Overridable Property studentSection As StudentSectionResponse
        End Class

        Public Partial Class StudentSectionResponse
            Inherits SectionResponse
            Public Overridable Property studentSectionUUID As String
            Public Overridable Property registered_amount As Decimal
            Public Overridable Property is_provisional As Boolean
            Public Overridable Property is_audit As Boolean
        End Class
    End Namespace
End Namespace

VB.NET ProvisionalRegistrationAuthorizeRequest 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/Provisional/{student_section_uuid}/Authorize HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"student_section_uuid":"String","authorizing_uuid":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"transaction_uuid":"String","studentSectionInvoiceItems":[{"studentSection":{"studentSectionUUID":"String","registered_amount":0,"is_provisional":false,"is_audit":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"secUUID":"String","course_name":"String","section_code":"String","course_title":"String","course_short_title":"String","course_description":"String","crosslist_description":"String","crosslist_course_name":"String","location_long_name":"String","room":"String","instructors":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"regent_login":"String","preferred_name":"String","first_name":"String","last_name":"String","full_name":"String","email":"String","image_base64":"String"}],"required_documents":[{"code":"String","document_name":"String","document_description":"String"}],"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","first_meeting_date":"0001-01-01T00:00:00.0000000","last_meeting_date":"0001-01-01T00:00:00.0000000","meeting_days":"String","start_times":["String"],"end_times":["String"],"is_online_only":false,"is_weekend":false,"is_weekday":false,"is_evening":false,"is_waitlist":false,"has_special_requirements":false,"special_requirements":"String","is_unlisted":false,"credit_amounts":[0],"audit_amounts":[0],"audits_short_name":"String","audits_long_name":"String","credits_short_name":"String","credits_long_name":"String","distance_ed_materials":"String","prerequisites":"String","corequisites":"String","capacity":0,"flat_fee_amount":0,"additional_fee_amount":0,"registered_students":0,"three_credit_plus":0,"two_credit":0,"one_credit":0,"three_audit_plus":0,"two_audit":0,"one_audit":0,"crosslist_registered_students":0,"grades_received":0,"crosslist_grades_received":0,"registration_start_date":"0001-01-01T00:00:00.0000000","registration_end_date":"0001-01-01T00:00:00.0000000","add_start_date":"0001-01-01T00:00:00.0000000","add_end_date":"0001-01-01T00:00:00.0000000","drop_start_date":"0001-01-01T00:00:00.0000000","drop_end_date":"0001-01-01T00:00:00.0000000","grading_end_date":"0001-01-01T00:00:00.0000000","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","timestamp":"0001-01-01T00:00:00.0000000"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","charge":0,"credit":0}],"sectionRates":{"String":[{"rate_id":0,"charge":0,"credit":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","secUUID":"String","section_id":0,"course_name":"String","section_code":"String","title":"String","reporting_term":"String","rate_code":"String","rate_description":"String","is_override_credit_rate":false,"is_override_audit_rate":false}]},"creditTuitionRate":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","is_required":false,"is_optional":false,"charge":0,"credit":0},"auditTuitionRate":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","is_required":false,"is_optional":false,"charge":0,"credit":0},"studentAge":0,"studentAgeAtEarliestSectionStartDate":0,"isRegentGrad":false,"isOnlyUnclassified":false,"canRegisterForAuditInTerm":false,"canRegisterForCreditInTerm":false,"messages":["String"],"currentTermAuditHours":0,"currentTermCreditHours":0,"totalCreditHours":0,"availableInvoiceItems":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","is_required":false,"is_optional":false,"charge":0,"credit":0}],"availableBenefits":[{"rate_id":0,"rate_code":"String","rate_description":"String","percentage_rate":0,"is_optional":false,"is_required":false}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceUUID":"String","regent_id":0,"uuid":"String","reporting_term":"String","total_charges":0,"total_credits":0,"current_status":"String","timestamp":"0001-01-01T00:00:00.0000000"}