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 Foundation
import ServiceStack

public class DropRegistrationsRequest : Codable
{
    public var uuid:String
    public var reporting_term:String
    public var registrations:[DropRegistrationResponse] = []
    public var override_drop_date:Date?
    public var authorizing_uuid:String

    required public init(){}
}

public class DropRegistrationResponse : Codable
{
    public var student_section_uuid:String
    public var course_name:String
    public var section_code:String
    public var title:String
    public var term:String
    public var amount:Double
    public var is_audit:Bool
    public var is_grade_final:Bool
    public var is_provisional:Bool
    public var is_selected_to_drop:Bool
    public var suggested_refund_percentage:Double
    public var suggested_refund_amount:Double
    public var balance_amount:Double
    public var charge_amount:Double
    public var credit_amount:Double
    public var Description:String
    public var additional_rate_description:String
    public var additional_rate_id:Int?
    public var additional_rate_amount:Double?
    public var additional_rate_suggested_refund_percentage:Double?
    public var additional_rate_suggested_refund_amount:Double?
    public var benefit_description:String
    public var second_benefit_description:String
    public var benefit_rate_id:Int?
    public var benefit_amount:Double?
    public var second_benefit_amount:Double?
    public var second_benefit_rate_id:Int?

    required public init(){}
}

public class DropRegistrationsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var transaction_uuid:String
    public var regent_id:Int
    public var uuid:String
    public var reporting_term:String
    public var suggested_drop_fee:Double
    public var suggested_full_student_fee_refund:Bool
    public var messages:[String] = []
    public var registrations:[DropRegistrationResponse] = []
    public var invoiceItemBalances:[InvoiceItemBalanceResponse] = []

    required public init(){}
}

public class InvoiceItemBalanceResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var rate_id:Int
    public var rate_code:String
    public var rate_description:String
    public var balance_amount:Double
    public var charge_amount:Double
    public var credit_amount:Double

    required public init(){}
}


Swift DropRegistrationsRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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: text/jsonl
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}]}