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}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class DropRegistrationsRequest
{
    var uuid:String? = null
    var reporting_term:String? = null
    var registrations:ArrayList<DropRegistrationResponse> = ArrayList<DropRegistrationResponse>()
    var override_drop_date:Date? = null
    var authorizing_uuid:String? = null
}

open class DropRegistrationResponse
{
    var student_section_uuid:String? = null
    var course_name:String? = null
    var section_code:String? = null
    var title:String? = null
    var term:String? = null
    var amount:BigDecimal? = null
    var is_audit:Boolean? = null
    var is_grade_final:Boolean? = null
    var is_provisional:Boolean? = null
    var is_selected_to_drop:Boolean? = null
    var suggested_refund_percentage:BigDecimal? = null
    var suggested_refund_amount:BigDecimal? = null
    var balance_amount:BigDecimal? = null
    var charge_amount:BigDecimal? = null
    var credit_amount:BigDecimal? = null
    var description:String? = null
    var additional_rate_description:String? = null
    var additional_rate_id:Int? = null
    var additional_rate_amount:BigDecimal? = null
    var additional_rate_suggested_refund_percentage:BigDecimal? = null
    var additional_rate_suggested_refund_amount:BigDecimal? = null
    var benefit_description:String? = null
    var second_benefit_description:String? = null
    var benefit_rate_id:Int? = null
    var benefit_amount:BigDecimal? = null
    var second_benefit_amount:BigDecimal? = null
    var second_benefit_rate_id:Int? = null
}

open class DropRegistrationsResponse
{
    var responseStatus:ResponseStatus? = null
    var transaction_uuid:String? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var reporting_term:String? = null
    var suggested_drop_fee:BigDecimal? = null
    var suggested_full_student_fee_refund:Boolean? = null
    var messages:ArrayList<String> = ArrayList<String>()
    var registrations:ArrayList<DropRegistrationResponse> = ArrayList<DropRegistrationResponse>()
    var invoiceItemBalances:ArrayList<InvoiceItemBalanceResponse> = ArrayList<InvoiceItemBalanceResponse>()
}

open class InvoiceItemBalanceResponse
{
    var responseStatus:ResponseStatus? = null
    var rate_id:Int? = null
    var rate_code:String? = null
    var rate_description:String? = null
    var balance_amount:BigDecimal? = null
    var charge_amount:BigDecimal? = null
    var credit_amount:BigDecimal? = null
}

Kotlin 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}]}