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}
"use strict";
export class DropRegistrationResponse {
    /** @param {{student_section_uuid?:string,course_name?:string,section_code?:string,title?:string,term?:string,amount?:number,is_audit?:boolean,is_grade_final?:boolean,is_provisional?:boolean,is_selected_to_drop?:boolean,suggested_refund_percentage?:number,suggested_refund_amount?:number,balance_amount?:number,charge_amount?:number,credit_amount?:number,description?:string,additional_rate_description?:string,additional_rate_id?:number,additional_rate_amount?:number,additional_rate_suggested_refund_percentage?:number,additional_rate_suggested_refund_amount?:number,benefit_description?:string,second_benefit_description?:string,benefit_rate_id?:number,benefit_amount?:number,second_benefit_amount?:number,second_benefit_rate_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    student_section_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    title;
    /** @type {string} */
    term;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_grade_final;
    /** @type {boolean} */
    is_provisional;
    /** @type {boolean} */
    is_selected_to_drop;
    /** @type {number} */
    suggested_refund_percentage;
    /** @type {number} */
    suggested_refund_amount;
    /** @type {number} */
    balance_amount;
    /** @type {number} */
    charge_amount;
    /** @type {number} */
    credit_amount;
    /** @type {string} */
    description;
    /** @type {string} */
    additional_rate_description;
    /** @type {?number} */
    additional_rate_id;
    /** @type {?number} */
    additional_rate_amount;
    /** @type {?number} */
    additional_rate_suggested_refund_percentage;
    /** @type {?number} */
    additional_rate_suggested_refund_amount;
    /** @type {string} */
    benefit_description;
    /** @type {string} */
    second_benefit_description;
    /** @type {?number} */
    benefit_rate_id;
    /** @type {?number} */
    benefit_amount;
    /** @type {?number} */
    second_benefit_amount;
    /** @type {?number} */
    second_benefit_rate_id;
}
export class InvoiceItemBalanceResponse {
    /** @param {{responseStatus?:ResponseStatus,rate_id?:number,rate_code?:string,rate_description?:string,balance_amount?:number,charge_amount?:number,credit_amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    rate_id;
    /** @type {string} */
    rate_code;
    /** @type {string} */
    rate_description;
    /** @type {number} */
    balance_amount;
    /** @type {number} */
    charge_amount;
    /** @type {number} */
    credit_amount;
}
export class DropRegistrationsResponse {
    /** @param {{responseStatus?:ResponseStatus,transaction_uuid?:string,regent_id?:number,uuid?:string,reporting_term?:string,suggested_drop_fee?:number,suggested_full_student_fee_refund?:boolean,messages?:string[],registrations?:DropRegistrationResponse[],invoiceItemBalances?:InvoiceItemBalanceResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    transaction_uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    suggested_drop_fee;
    /** @type {boolean} */
    suggested_full_student_fee_refund;
    /** @type {string[]} */
    messages;
    /** @type {DropRegistrationResponse[]} */
    registrations;
    /** @type {InvoiceItemBalanceResponse[]} */
    invoiceItemBalances;
}
export class DropRegistrationsRequest {
    /** @param {{uuid?:string,reporting_term?:string,registrations?:DropRegistrationResponse[],override_drop_date?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {DropRegistrationResponse[]} */
    registrations;
    /** @type {?string} */
    override_drop_date;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript 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}]}