| Required role: | REGISUserRole |
| POST | /Registration/{uuid}/Drop/{reporting_term} |
|---|
namespace regis.ClassLibrary.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type DropRegistrationResponse() =
member val student_section_uuid:String = null with get,set
member val course_name:String = null with get,set
member val section_code:String = null with get,set
member val title:String = null with get,set
member val term:String = null with get,set
member val amount:Decimal = new Decimal() with get,set
member val is_audit:Boolean = new Boolean() with get,set
member val is_grade_final:Boolean = new Boolean() with get,set
member val is_provisional:Boolean = new Boolean() with get,set
member val is_selected_to_drop:Boolean = new Boolean() with get,set
member val suggested_refund_percentage:Decimal = new Decimal() with get,set
member val suggested_refund_amount:Decimal = new Decimal() with get,set
member val balance_amount:Decimal = new Decimal() with get,set
member val charge_amount:Decimal = new Decimal() with get,set
member val credit_amount:Decimal = new Decimal() with get,set
member val description:String = null with get,set
member val additional_rate_description:String = null with get,set
member val additional_rate_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val additional_rate_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val additional_rate_suggested_refund_percentage:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val additional_rate_suggested_refund_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val benefit_description:String = null with get,set
member val second_benefit_description:String = null with get,set
member val benefit_rate_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_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val second_benefit_rate_id:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type InvoiceItemBalanceResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val rate_id:Int32 = new Int32() with get,set
member val rate_code:String = null with get,set
member val rate_description:String = null with get,set
member val balance_amount:Decimal = new Decimal() with get,set
member val charge_amount:Decimal = new Decimal() with get,set
member val credit_amount:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type DropRegistrationsResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val transaction_uuid:String = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val uuid:String = null with get,set
member val reporting_term:String = null with get,set
member val suggested_drop_fee:Decimal = new Decimal() with get,set
member val suggested_full_student_fee_refund:Boolean = new Boolean() with get,set
member val messages:ResizeArray<String> = new ResizeArray<String>() with get,set
member val registrations:ResizeArray<DropRegistrationResponse> = new ResizeArray<DropRegistrationResponse>() with get,set
member val invoiceItemBalances:ResizeArray<InvoiceItemBalanceResponse> = new ResizeArray<InvoiceItemBalanceResponse>() with get,set
[<AllowNullLiteral>]
type DropRegistrationsRequest() =
member val uuid:String = null with get,set
member val reporting_term:String = null with get,set
member val registrations:ResizeArray<DropRegistrationResponse> = new ResizeArray<DropRegistrationResponse>() with get,set
member val override_drop_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val authorizing_uuid:String = null with get,set
F# DropRegistrationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
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-01,
authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
]
}