regis

<back to all web services

TermStatementRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TermStatements/{uuid}/{reporting_term}

export class TermStatementRegistrationResponse
{
    public course_name: string;
    public title: string;
    public section_code: string;
    public amount: number;
    public is_audit: boolean;
    public meeting_days: string;
    public times: string;
    public room: string;
    public instructor: string;
    public status: string;
    public cost: number;
    public start_date?: string;
    public end_date?: string;

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

export class TermStatementChargesResponse
{
    public date: string;
    public code: string;
    public description: string;
    public is_financial_aid: boolean;
    public charge: number;

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

export class TermStatementResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public name: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public reporting_term: string;
    public reporting_term_start_date: string;
    public reporting_term_end_date: string;
    public academic_program: string;
    public total_term_payments: number;
    public total_term_charges: number;
    public total_term_taxes: number;
    public registrations: TermStatementRegistrationResponse[];
    public charges: TermStatementChargesResponse[];

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

export class TermStatementRequest
{
    public uuid: string;
    public reporting_term: string;
    public authorizing_uuid: string;

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

TypeScript TermStatementRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /TermStatements/{uuid}/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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,"uuid":"String","name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","reporting_term":"String","reporting_term_start_date":"0001-01-01T00:00:00.0000000","reporting_term_end_date":"0001-01-01T00:00:00.0000000","academic_program":"String","total_term_payments":0,"total_term_charges":0,"total_term_taxes":0,"registrations":[{"course_name":"String","title":"String","section_code":"String","amount":0,"is_audit":false,"meeting_days":"String","times":"String","room":"String","instructor":"String","status":"String","cost":0,"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}],"charges":[{"date":"0001-01-01T00:00:00.0000000","code":"String","description":"String","is_financial_aid":false,"charge":0}]}