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
"use strict";
export class DropRegistrationsForBalanceOwingRequest {
    /** @param {{authorizing_uuid?:string,reporting_term?:string,is_preview_only?:boolean,override_drop_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {boolean} */
    is_preview_only;
    /** @type {?string} */
    override_drop_date;
}

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

{"authorizing_uuid":"String","reporting_term":"String","is_preview_only":false,"override_drop_date":"0001-01-01T00:00:00.0000000"}
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"}},"regent_id":0,"first_name":"String","last_name":"String","uuid":"String","amount_owing":0,"reporting_term":"String","active_financial_restrictions":"String","sections_dropped":[{"student_section_uuid":"String","tuition_refund_amount":0,"description":"String","additional_rate_id":0,"additional_rate_amount":0,"benefit_rate_id":0,"second_benefit_rate_id":0,"benefit_charge_amount":0,"second_benefit_charge_amount":0}]}]