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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}]}