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

export class DropRegistrationSubmitRequest
{
    public student_section_uuid: string;
    public tuition_refund_amount: number;
    public description: string;
    public additional_rate_id?: number;
    public additional_rate_amount?: number;
    public benefit_rate_id?: number;
    public second_benefit_rate_id?: number;
    public benefit_charge_amount?: number;
    public second_benefit_charge_amount?: number;

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

export class DropRegistrationsSubmitRequest
{
    public transaction_uuid: string;
    public uuid: string;
    public reporting_term: string;
    public registrations: DropRegistrationSubmitRequest[];
    public description: string;
    public drop_fee?: number;
    public drop_description: string;
    public refund_student_fees: boolean;
    public authorizing_uuid: string;

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

TypeScript 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"}}