regis

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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<DropRegistrationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <override_drop_date>0001-01-01T00:00:00</override_drop_date>
  <registrations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
    <d2p1:DropRegistrationResponse>
      <d2p1:additional_rate_amount>0</d2p1:additional_rate_amount>
      <d2p1:additional_rate_description>String</d2p1:additional_rate_description>
      <d2p1:additional_rate_id>0</d2p1:additional_rate_id>
      <d2p1:additional_rate_suggested_refund_amount>0</d2p1:additional_rate_suggested_refund_amount>
      <d2p1:additional_rate_suggested_refund_percentage>0</d2p1:additional_rate_suggested_refund_percentage>
      <d2p1:amount>0</d2p1:amount>
      <d2p1:balance_amount>0</d2p1:balance_amount>
      <d2p1:benefit_amount>0</d2p1:benefit_amount>
      <d2p1:benefit_description>String</d2p1:benefit_description>
      <d2p1:benefit_rate_id>0</d2p1:benefit_rate_id>
      <d2p1:charge_amount>0</d2p1:charge_amount>
      <d2p1:course_name>String</d2p1:course_name>
      <d2p1:credit_amount>0</d2p1:credit_amount>
      <d2p1:description>String</d2p1:description>
      <d2p1:is_audit>false</d2p1:is_audit>
      <d2p1:is_grade_final>false</d2p1:is_grade_final>
      <d2p1:is_provisional>false</d2p1:is_provisional>
      <d2p1:is_selected_to_drop>false</d2p1:is_selected_to_drop>
      <d2p1:second_benefit_amount>0</d2p1:second_benefit_amount>
      <d2p1:second_benefit_description>String</d2p1:second_benefit_description>
      <d2p1:second_benefit_rate_id>0</d2p1:second_benefit_rate_id>
      <d2p1:section_code>String</d2p1:section_code>
      <d2p1:student_section_uuid>String</d2p1:student_section_uuid>
      <d2p1:suggested_refund_amount>0</d2p1:suggested_refund_amount>
      <d2p1:suggested_refund_percentage>0</d2p1:suggested_refund_percentage>
      <d2p1:term>String</d2p1:term>
      <d2p1:title>String</d2p1:title>
    </d2p1:DropRegistrationResponse>
  </registrations>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</DropRegistrationsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DropRegistrationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <invoiceItemBalances>
    <InvoiceItemBalanceResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <balance_amount>0</balance_amount>
      <charge_amount>0</charge_amount>
      <credit_amount>0</credit_amount>
      <rate_code>String</rate_code>
      <rate_description>String</rate_description>
      <rate_id>0</rate_id>
    </InvoiceItemBalanceResponse>
  </invoiceItemBalances>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <regent_id>0</regent_id>
  <registrations>
    <DropRegistrationResponse>
      <additional_rate_amount>0</additional_rate_amount>
      <additional_rate_description>String</additional_rate_description>
      <additional_rate_id>0</additional_rate_id>
      <additional_rate_suggested_refund_amount>0</additional_rate_suggested_refund_amount>
      <additional_rate_suggested_refund_percentage>0</additional_rate_suggested_refund_percentage>
      <amount>0</amount>
      <balance_amount>0</balance_amount>
      <benefit_amount>0</benefit_amount>
      <benefit_description>String</benefit_description>
      <benefit_rate_id>0</benefit_rate_id>
      <charge_amount>0</charge_amount>
      <course_name>String</course_name>
      <credit_amount>0</credit_amount>
      <description>String</description>
      <is_audit>false</is_audit>
      <is_grade_final>false</is_grade_final>
      <is_provisional>false</is_provisional>
      <is_selected_to_drop>false</is_selected_to_drop>
      <second_benefit_amount>0</second_benefit_amount>
      <second_benefit_description>String</second_benefit_description>
      <second_benefit_rate_id>0</second_benefit_rate_id>
      <section_code>String</section_code>
      <student_section_uuid>String</student_section_uuid>
      <suggested_refund_amount>0</suggested_refund_amount>
      <suggested_refund_percentage>0</suggested_refund_percentage>
      <term>String</term>
      <title>String</title>
    </DropRegistrationResponse>
  </registrations>
  <reporting_term>String</reporting_term>
  <suggested_drop_fee>0</suggested_drop_fee>
  <suggested_full_student_fee_refund>false</suggested_full_student_fee_refund>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</DropRegistrationsResponse>