regis

<back to all web services

DropRegistrationsSubmitRequest

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

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class DropRegistrationsSubmitRequest
            Public Sub New()
                registrations = New List(Of DropRegistrationSubmitRequest)
            End Sub

            Public Overridable Property transaction_uuid As String
            Public Overridable Property uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property registrations As List(Of DropRegistrationSubmitRequest)
            Public Overridable Property description As String
            Public Overridable Property drop_fee As Nullable(Of Decimal)
            Public Overridable Property drop_description As String
            Public Overridable Property refund_student_fees As Boolean
            Public Overridable Property authorizing_uuid As String
        End Class

        Public Partial Class DropRegistrationSubmitRequest
            Public Overridable Property student_section_uuid As String
            Public Overridable Property tuition_refund_amount As Decimal
            Public Overridable Property 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 benefit_rate_id As Nullable(Of Integer)
            Public Overridable Property second_benefit_rate_id As Nullable(Of Integer)
            Public Overridable Property benefit_charge_amount As Nullable(Of Decimal)
            Public Overridable Property second_benefit_charge_amount As Nullable(Of Decimal)
        End Class
    End Namespace
End Namespace

VB.NET DropRegistrationsSubmitRequest DTOs

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

HTTP + JSV

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

POST /Registration/{uuid}/Drop/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	transaction_uuid: String,
	uuid: String,
	reporting_term: String,
	registrations: 
	[
		{
			student_section_uuid: String,
			tuition_refund_amount: 0,
			description: String,
			additional_rate_id: 0,
			additional_rate_amount: 0,
			benefit_rate_id: 0,
			second_benefit_rate_id: 0,
			benefit_charge_amount: 0,
			second_benefit_charge_amount: 0
		}
	],
	description: String,
	drop_fee: 0,
	drop_description: String,
	refund_student_fees: False,
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}