Required role: | REGISUserRole |
POST | /Registration/{uuid}/Drop/{reporting_term} |
---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class DropRegistrationsRequest
{
public String uuid = null;
public String reporting_term = null;
public ArrayList<DropRegistrationResponse> registrations = null;
public Date override_drop_date = null;
public String authorizing_uuid = null;
public String getUuid() { return uuid; }
public DropRegistrationsRequest setUuid(String value) { this.uuid = value; return this; }
public String getReportingTerm() { return reporting_term; }
public DropRegistrationsRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
public ArrayList<DropRegistrationResponse> getRegistrations() { return registrations; }
public DropRegistrationsRequest setRegistrations(ArrayList<DropRegistrationResponse> value) { this.registrations = value; return this; }
public Date getOverrideDropDate() { return override_drop_date; }
public DropRegistrationsRequest setOverrideDropDate(Date value) { this.override_drop_date = value; return this; }
public String getAuthorizingUuid() { return authorizing_uuid; }
public DropRegistrationsRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
}
public static class DropRegistrationResponse
{
public String student_section_uuid = null;
public String course_name = null;
public String section_code = null;
public String title = null;
public String term = null;
public BigDecimal amount = null;
public Boolean is_audit = null;
public Boolean is_grade_final = null;
public Boolean is_provisional = null;
public Boolean is_selected_to_drop = null;
public BigDecimal suggested_refund_percentage = null;
public BigDecimal suggested_refund_amount = null;
public BigDecimal balance_amount = null;
public BigDecimal charge_amount = null;
public BigDecimal credit_amount = null;
public String description = null;
public String additional_rate_description = null;
public Integer additional_rate_id = null;
public BigDecimal additional_rate_amount = null;
public BigDecimal additional_rate_suggested_refund_percentage = null;
public BigDecimal additional_rate_suggested_refund_amount = null;
public String benefit_description = null;
public String second_benefit_description = null;
public Integer benefit_rate_id = null;
public BigDecimal benefit_amount = null;
public BigDecimal second_benefit_amount = null;
public Integer second_benefit_rate_id = null;
public String getStudentSectionUuid() { return student_section_uuid; }
public DropRegistrationResponse setStudentSectionUuid(String value) { this.student_section_uuid = value; return this; }
public String getCourseName() { return course_name; }
public DropRegistrationResponse setCourseName(String value) { this.course_name = value; return this; }
public String getSectionCode() { return section_code; }
public DropRegistrationResponse setSectionCode(String value) { this.section_code = value; return this; }
public String getTitle() { return title; }
public DropRegistrationResponse setTitle(String value) { this.title = value; return this; }
public String getTerm() { return term; }
public DropRegistrationResponse setTerm(String value) { this.term = value; return this; }
public BigDecimal getAmount() { return amount; }
public DropRegistrationResponse setAmount(BigDecimal value) { this.amount = value; return this; }
public Boolean getIsAudit() { return is_audit; }
public DropRegistrationResponse setIsAudit(Boolean value) { this.is_audit = value; return this; }
public Boolean getIsGradeFinal() { return is_grade_final; }
public DropRegistrationResponse setIsGradeFinal(Boolean value) { this.is_grade_final = value; return this; }
public Boolean getIsProvisional() { return is_provisional; }
public DropRegistrationResponse setIsProvisional(Boolean value) { this.is_provisional = value; return this; }
public Boolean getIsSelectedToDrop() { return is_selected_to_drop; }
public DropRegistrationResponse setIsSelectedToDrop(Boolean value) { this.is_selected_to_drop = value; return this; }
public BigDecimal getSuggestedRefundPercentage() { return suggested_refund_percentage; }
public DropRegistrationResponse setSuggestedRefundPercentage(BigDecimal value) { this.suggested_refund_percentage = value; return this; }
public BigDecimal getSuggestedRefundAmount() { return suggested_refund_amount; }
public DropRegistrationResponse setSuggestedRefundAmount(BigDecimal value) { this.suggested_refund_amount = value; return this; }
public BigDecimal getBalanceAmount() { return balance_amount; }
public DropRegistrationResponse setBalanceAmount(BigDecimal value) { this.balance_amount = value; return this; }
public BigDecimal getChargeAmount() { return charge_amount; }
public DropRegistrationResponse setChargeAmount(BigDecimal value) { this.charge_amount = value; return this; }
public BigDecimal getCreditAmount() { return credit_amount; }
public DropRegistrationResponse setCreditAmount(BigDecimal value) { this.credit_amount = value; return this; }
public String getDescription() { return description; }
public DropRegistrationResponse setDescription(String value) { this.description = value; return this; }
public String getAdditionalRateDescription() { return additional_rate_description; }
public DropRegistrationResponse setAdditionalRateDescription(String value) { this.additional_rate_description = value; return this; }
public Integer getAdditionalRateId() { return additional_rate_id; }
public DropRegistrationResponse setAdditionalRateId(Integer value) { this.additional_rate_id = value; return this; }
public BigDecimal getAdditionalRateAmount() { return additional_rate_amount; }
public DropRegistrationResponse setAdditionalRateAmount(BigDecimal value) { this.additional_rate_amount = value; return this; }
public BigDecimal getAdditionalRateSuggestedRefundPercentage() { return additional_rate_suggested_refund_percentage; }
public DropRegistrationResponse setAdditionalRateSuggestedRefundPercentage(BigDecimal value) { this.additional_rate_suggested_refund_percentage = value; return this; }
public BigDecimal getAdditionalRateSuggestedRefundAmount() { return additional_rate_suggested_refund_amount; }
public DropRegistrationResponse setAdditionalRateSuggestedRefundAmount(BigDecimal value) { this.additional_rate_suggested_refund_amount = value; return this; }
public String getBenefitDescription() { return benefit_description; }
public DropRegistrationResponse setBenefitDescription(String value) { this.benefit_description = value; return this; }
public String getSecondBenefitDescription() { return second_benefit_description; }
public DropRegistrationResponse setSecondBenefitDescription(String value) { this.second_benefit_description = value; return this; }
public Integer getBenefitRateId() { return benefit_rate_id; }
public DropRegistrationResponse setBenefitRateId(Integer value) { this.benefit_rate_id = value; return this; }
public BigDecimal getBenefitAmount() { return benefit_amount; }
public DropRegistrationResponse setBenefitAmount(BigDecimal value) { this.benefit_amount = value; return this; }
public BigDecimal getSecondBenefitAmount() { return second_benefit_amount; }
public DropRegistrationResponse setSecondBenefitAmount(BigDecimal value) { this.second_benefit_amount = value; return this; }
public Integer getSecondBenefitRateId() { return second_benefit_rate_id; }
public DropRegistrationResponse setSecondBenefitRateId(Integer value) { this.second_benefit_rate_id = value; return this; }
}
public static class DropRegistrationsResponse
{
public ResponseStatus responseStatus = null;
public String transaction_uuid = null;
public Integer regent_id = null;
public String uuid = null;
public String reporting_term = null;
public BigDecimal suggested_drop_fee = null;
public Boolean suggested_full_student_fee_refund = null;
public ArrayList<String> messages = null;
public ArrayList<DropRegistrationResponse> registrations = null;
public ArrayList<InvoiceItemBalanceResponse> invoiceItemBalances = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public DropRegistrationsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public String getTransactionUuid() { return transaction_uuid; }
public DropRegistrationsResponse setTransactionUuid(String value) { this.transaction_uuid = value; return this; }
public Integer getRegentId() { return regent_id; }
public DropRegistrationsResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public String getUuid() { return uuid; }
public DropRegistrationsResponse setUuid(String value) { this.uuid = value; return this; }
public String getReportingTerm() { return reporting_term; }
public DropRegistrationsResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
public BigDecimal getSuggestedDropFee() { return suggested_drop_fee; }
public DropRegistrationsResponse setSuggestedDropFee(BigDecimal value) { this.suggested_drop_fee = value; return this; }
public Boolean isSuggestedFullStudentFeeRefund() { return suggested_full_student_fee_refund; }
public DropRegistrationsResponse setSuggestedFullStudentFeeRefund(Boolean value) { this.suggested_full_student_fee_refund = value; return this; }
public ArrayList<String> getMessages() { return messages; }
public DropRegistrationsResponse setMessages(ArrayList<String> value) { this.messages = value; return this; }
public ArrayList<DropRegistrationResponse> getRegistrations() { return registrations; }
public DropRegistrationsResponse setRegistrations(ArrayList<DropRegistrationResponse> value) { this.registrations = value; return this; }
public ArrayList<InvoiceItemBalanceResponse> getInvoiceItemBalances() { return invoiceItemBalances; }
public DropRegistrationsResponse setInvoiceItemBalances(ArrayList<InvoiceItemBalanceResponse> value) { this.invoiceItemBalances = value; return this; }
}
public static class InvoiceItemBalanceResponse
{
public ResponseStatus responseStatus = null;
public Integer rate_id = null;
public String rate_code = null;
public String rate_description = null;
public BigDecimal balance_amount = null;
public BigDecimal charge_amount = null;
public BigDecimal credit_amount = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public InvoiceItemBalanceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Integer getRateId() { return rate_id; }
public InvoiceItemBalanceResponse setRateId(Integer value) { this.rate_id = value; return this; }
public String getRateCode() { return rate_code; }
public InvoiceItemBalanceResponse setRateCode(String value) { this.rate_code = value; return this; }
public String getRateDescription() { return rate_description; }
public InvoiceItemBalanceResponse setRateDescription(String value) { this.rate_description = value; return this; }
public BigDecimal getBalanceAmount() { return balance_amount; }
public InvoiceItemBalanceResponse setBalanceAmount(BigDecimal value) { this.balance_amount = value; return this; }
public BigDecimal getChargeAmount() { return charge_amount; }
public InvoiceItemBalanceResponse setChargeAmount(BigDecimal value) { this.charge_amount = value; return this; }
public BigDecimal getCreditAmount() { return credit_amount; }
public InvoiceItemBalanceResponse setCreditAmount(BigDecimal value) { this.credit_amount = value; return this; }
}
}
Java DropRegistrationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>