regis

<back to all web services

DropRegistrationsForBalanceOwingRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{reporting_term}/DropForBalanceOwing
DropRegistrationsForBalanceOwingRequest Parameters:
NameParameterData TypeRequiredDescription
authorizing_uuidbodystringNo
reporting_termpathstringNo
is_preview_onlybodyboolNo
override_drop_datebodyDateTime?No

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/{reporting_term}/DropForBalanceOwing HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DropRegistrationsForBalanceOwingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <is_preview_only>false</is_preview_only>
  <override_drop_date>0001-01-01T00:00:00</override_drop_date>
  <reporting_term>String</reporting_term>
</DropRegistrationsForBalanceOwingRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDropRegistrationsForBalanceOwingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <DropRegistrationsForBalanceOwingResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <active_financial_restrictions>String</active_financial_restrictions>
    <amount_owing>0</amount_owing>
    <first_name>String</first_name>
    <last_name>String</last_name>
    <regent_id>0</regent_id>
    <reporting_term>String</reporting_term>
    <sections_dropped xmlns:d3p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
      <d3p1:DropRegistrationSubmitRequest>
        <d3p1:additional_rate_amount>0</d3p1:additional_rate_amount>
        <d3p1:additional_rate_id>0</d3p1:additional_rate_id>
        <d3p1:benefit_charge_amount>0</d3p1:benefit_charge_amount>
        <d3p1:benefit_rate_id>0</d3p1:benefit_rate_id>
        <d3p1:description>String</d3p1:description>
        <d3p1:second_benefit_charge_amount>0</d3p1:second_benefit_charge_amount>
        <d3p1:second_benefit_rate_id>0</d3p1:second_benefit_rate_id>
        <d3p1:student_section_uuid>String</d3p1:student_section_uuid>
        <d3p1:tuition_refund_amount>0</d3p1:tuition_refund_amount>
      </d3p1:DropRegistrationSubmitRequest>
    </sections_dropped>
    <uuid>String</uuid>
  </DropRegistrationsForBalanceOwingResponse>
</ArrayOfDropRegistrationsForBalanceOwingResponse>