regis

DropRegistrationsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/{uuid}/Drop/{reporting_term}


export class DropRegistrationResponse
{
    public student_section_uuid: string;
    public course_name: string;
    public section_code: string;
    public title: string;
    public term: string;
    public amount: number;
    public is_audit: boolean;
    public is_grade_final: boolean;
    public is_provisional: boolean;
    public is_selected_to_drop: boolean;
    public suggested_refund_percentage: number;
    public suggested_refund_amount: number;
    public balance_amount: number;
    public charge_amount: number;
    public credit_amount: number;
    public description: string;
    public additional_rate_description: string;
    public additional_rate_id?: number;
    public additional_rate_amount?: number;
    public additional_rate_suggested_refund_percentage?: number;
    public additional_rate_suggested_refund_amount?: number;
    public benefit_description: string;
    public second_benefit_description: string;
    public benefit_rate_id?: number;
    public benefit_amount?: number;
    public second_benefit_amount?: number;
    public second_benefit_rate_id?: number;

    public constructor(init?: Partial<DropRegistrationResponse>) { (Object as any).assign(this, init); }
}

export class InvoiceItemBalanceResponse
{
    public responseStatus: ResponseStatus;
    public rate_id: number;
    public rate_code: string;
    public rate_description: string;
    public balance_amount: number;
    public charge_amount: number;
    public credit_amount: number;

    public constructor(init?: Partial<InvoiceItemBalanceResponse>) { (Object as any).assign(this, init); }
}

export class DropRegistrationsResponse
{
    public responseStatus: ResponseStatus;
    public transaction_uuid: string;
    public regent_id: number;
    public uuid: string;
    public reporting_term: string;
    public suggested_drop_fee: number;
    public suggested_full_student_fee_refund: boolean;
    public messages: string[];
    public registrations: DropRegistrationResponse[];
    public invoiceItemBalances: InvoiceItemBalanceResponse[];

    public constructor(init?: Partial<DropRegistrationsResponse>) { (Object as any).assign(this, init); }
}

export class DropRegistrationsRequest
{
    public uuid: string;
    public reporting_term: string;
    public registrations: DropRegistrationResponse[];
    public override_drop_date?: string;
    public authorizing_uuid: string;

    public constructor(init?: Partial<DropRegistrationsRequest>) { (Object as any).assign(this, init); }
}

TypeScript DropRegistrationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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}]}