Required role: | REGISUserRole |
POST | /Registration/{uuid}/Drop/{reporting_term} |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;
namespace regis.ClassLibrary.Requests
{
public partial class DropRegistrationsRequest
{
public DropRegistrationsRequest()
{
registrations = new List<DropRegistrationResponse>{};
}
public virtual string uuid { get; set; }
public virtual string reporting_term { get; set; }
public virtual List<DropRegistrationResponse> registrations { get; set; }
public virtual DateTime? override_drop_date { get; set; }
public virtual string authorizing_uuid { get; set; }
}
}
namespace regis.ClassLibrary.Responses
{
public partial class DropRegistrationResponse
{
public virtual string student_section_uuid { get; set; }
public virtual string course_name { get; set; }
public virtual string section_code { get; set; }
public virtual string title { get; set; }
public virtual string term { get; set; }
public virtual decimal amount { get; set; }
public virtual bool is_audit { get; set; }
public virtual bool is_grade_final { get; set; }
public virtual bool is_provisional { get; set; }
public virtual bool is_selected_to_drop { get; set; }
public virtual decimal suggested_refund_percentage { get; set; }
public virtual decimal suggested_refund_amount { get; set; }
public virtual decimal balance_amount { get; set; }
public virtual decimal charge_amount { get; set; }
public virtual decimal credit_amount { get; set; }
public virtual string description { get; set; }
public virtual string additional_rate_description { get; set; }
public virtual int? additional_rate_id { get; set; }
public virtual decimal? additional_rate_amount { get; set; }
public virtual decimal? additional_rate_suggested_refund_percentage { get; set; }
public virtual decimal? additional_rate_suggested_refund_amount { get; set; }
public virtual string benefit_description { get; set; }
public virtual string second_benefit_description { get; set; }
public virtual int? benefit_rate_id { get; set; }
public virtual decimal? benefit_amount { get; set; }
public virtual decimal? second_benefit_amount { get; set; }
public virtual int? second_benefit_rate_id { get; set; }
}
public partial class DropRegistrationsResponse
{
public DropRegistrationsResponse()
{
messages = new List<string>{};
registrations = new List<DropRegistrationResponse>{};
invoiceItemBalances = new List<InvoiceItemBalanceResponse>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual string transaction_uuid { get; set; }
public virtual int regent_id { get; set; }
public virtual string uuid { get; set; }
public virtual string reporting_term { get; set; }
public virtual decimal suggested_drop_fee { get; set; }
public virtual bool suggested_full_student_fee_refund { get; set; }
public virtual List<string> messages { get; set; }
public virtual List<DropRegistrationResponse> registrations { get; set; }
public virtual List<InvoiceItemBalanceResponse> invoiceItemBalances { get; set; }
}
public partial class InvoiceItemBalanceResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual int rate_id { get; set; }
public virtual string rate_code { get; set; }
public virtual string rate_description { get; set; }
public virtual decimal balance_amount { get; set; }
public virtual decimal charge_amount { get; set; }
public virtual decimal credit_amount { get; set; }
}
}
C# 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>