regis

<back to all web services

DropRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{reporting_term}/Submit
"use strict";
export class DropRegistrationSubmitRequest {
    /** @param {{student_section_uuid?:string,tuition_refund_amount?:number,description?:string,additional_rate_id?:number,additional_rate_amount?:number,benefit_rate_id?:number,second_benefit_rate_id?:number,benefit_charge_amount?:number,second_benefit_charge_amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    student_section_uuid;
    /** @type {number} */
    tuition_refund_amount;
    /** @type {string} */
    description;
    /** @type {?number} */
    additional_rate_id;
    /** @type {?number} */
    additional_rate_amount;
    /** @type {?number} */
    benefit_rate_id;
    /** @type {?number} */
    second_benefit_rate_id;
    /** @type {?number} */
    benefit_charge_amount;
    /** @type {?number} */
    second_benefit_charge_amount;
}
export class DropRegistrationsSubmitRequest {
    /** @param {{transaction_uuid?:string,uuid?:string,reporting_term?:string,registrations?:DropRegistrationSubmitRequest[],description?:string,drop_fee?:number,drop_description?:string,refund_student_fees?:boolean,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {DropRegistrationSubmitRequest[]} */
    registrations;
    /** @type {string} */
    description;
    /** @type {?number} */
    drop_fee;
    /** @type {string} */
    drop_description;
    /** @type {boolean} */
    refund_student_fees;
    /** @type {string} */
    authorizing_uuid;
}

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

{"transaction_uuid":"String","uuid":"String","reporting_term":"String","registrations":[{"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}],"description":"String","drop_fee":0,"drop_description":"String","refund_student_fees":false,"authorizing_uuid":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}