regis

<back to all web services

DropRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{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 DropRegistrationsRequest
            Public Sub New()
                registrations = New List(Of DropRegistrationResponse)
            End Sub

            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property registrations As List(Of DropRegistrationResponse)
            Public Overridable Property override_drop_date As Nullable(Of Date)
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class DropRegistrationResponse
            Public Overridable Property student_section_uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property title As String
            Public Overridable Property term As String
            Public Overridable Property amount As Decimal
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_grade_final As Boolean
            Public Overridable Property is_provisional As Boolean
            Public Overridable Property is_selected_to_drop As Boolean
            Public Overridable Property suggested_refund_percentage As Decimal
            Public Overridable Property suggested_refund_amount As Decimal
            Public Overridable Property balance_amount As Decimal
            Public Overridable Property charge_amount As Decimal
            Public Overridable Property credit_amount As Decimal
            Public Overridable Property description As String
            Public Overridable Property additional_rate_description As String
            Public Overridable Property additional_rate_id As Nullable(Of Integer)
            Public Overridable Property additional_rate_amount As Nullable(Of Decimal)
            Public Overridable Property additional_rate_suggested_refund_percentage As Nullable(Of Decimal)
            Public Overridable Property additional_rate_suggested_refund_amount As Nullable(Of Decimal)
            Public Overridable Property benefit_description As String
            Public Overridable Property second_benefit_description As String
            Public Overridable Property benefit_rate_id As Nullable(Of Integer)
            Public Overridable Property benefit_amount As Nullable(Of Decimal)
            Public Overridable Property second_benefit_amount As Nullable(Of Decimal)
            Public Overridable Property second_benefit_rate_id As Nullable(Of Integer)
        End Class

        Public Partial Class DropRegistrationsResponse
            Public Sub New()
                messages = New List(Of String)
                registrations = New List(Of DropRegistrationResponse)
                invoiceItemBalances = New List(Of InvoiceItemBalanceResponse)
            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 suggested_drop_fee As Decimal
            Public Overridable Property suggested_full_student_fee_refund As Boolean
            Public Overridable Property messages As List(Of String)
            Public Overridable Property registrations As List(Of DropRegistrationResponse)
            Public Overridable Property invoiceItemBalances As List(Of InvoiceItemBalanceResponse)
        End Class

        Public Partial Class InvoiceItemBalanceResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property rate_id As Integer
            Public Overridable Property rate_code As String
            Public Overridable Property rate_description As String
            Public Overridable Property balance_amount As Decimal
            Public Overridable Property charge_amount As Decimal
            Public Overridable Property credit_amount As Decimal
        End Class
    End Namespace
End Namespace

VB.NET DropRegistrationsRequest 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/{uuid}/Drop/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","reporting_term":"String","registrations":[{"student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_grade_final":false,"is_provisional":false,"is_selected_to_drop":false,"suggested_refund_percentage":0,"suggested_refund_amount":0,"balance_amount":0,"charge_amount":0,"credit_amount":0,"description":"String","additional_rate_description":"String","additional_rate_id":0,"additional_rate_amount":0,"additional_rate_suggested_refund_percentage":0,"additional_rate_suggested_refund_amount":0,"benefit_description":"String","second_benefit_description":"String","benefit_rate_id":0,"benefit_amount":0,"second_benefit_amount":0,"second_benefit_rate_id":0}],"override_drop_date":"0001-01-01T00:00:00.0000000","authorizing_uuid":"String"}

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","suggested_drop_fee":0,"suggested_full_student_fee_refund":false,"messages":["String"],"registrations":[{"student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_grade_final":false,"is_provisional":false,"is_selected_to_drop":false,"suggested_refund_percentage":0,"suggested_refund_amount":0,"balance_amount":0,"charge_amount":0,"credit_amount":0,"description":"String","additional_rate_description":"String","additional_rate_id":0,"additional_rate_amount":0,"additional_rate_suggested_refund_percentage":0,"additional_rate_suggested_refund_amount":0,"benefit_description":"String","second_benefit_description":"String","benefit_rate_id":0,"benefit_amount":0,"second_benefit_amount":0,"second_benefit_rate_id":0}],"invoiceItemBalances":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"rate_id":0,"rate_code":"String","rate_description":"String","balance_amount":0,"charge_amount":0,"credit_amount":0}]}