regis

<back to all web services

AddRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{reporting_term}/Submit
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AddRegistrationWithBenefitRequest() = 
        member val student_section_uuid:String = null with get,set
        member val description:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val charge:Decimal = new Decimal() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val benefit_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val benefit_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val second_benefit_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val second_benefit_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type AddRegistrationsAdditionalChargeSubmitRequest() = 
        member val rate_id:Int32 = new Int32() with get,set
        member val description:String = null with get,set
        member val charge:Decimal = new Decimal() with get,set
        member val credit:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type AddRegistrationsSubmitRequest() = 
        member val transaction_uuid:String = null with get,set
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val description:String = null with get,set
        member val email_student:Boolean = new Boolean() with get,set
        member val registrations:ResizeArray<AddRegistrationWithBenefitRequest> = new ResizeArray<AddRegistrationWithBenefitRequest>() with get,set
        member val additional_term_charges:ResizeArray<AddRegistrationsAdditionalChargeSubmitRequest> = new ResizeArray<AddRegistrationsAdditionalChargeSubmitRequest>() with get,set
        member val authorizing_uuid:String = null with get,set

F# AddRegistrationsSubmitRequest 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}/Add/{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,
	description: String,
	email_student: False,
	registrations: 
	[
		{
			student_section_uuid: String,
			description: String,
			amount: 0,
			charge: 0,
			is_audit: False,
			benefit_id: 0,
			benefit_amount: 0,
			second_benefit_id: 0,
			second_benefit_amount: 0
		}
	],
	additional_term_charges: 
	[
		{
			rate_id: 0,
			description: String,
			charge: 0,
			credit: 0
		}
	],
	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
	}
}