regis

<back to all web services

RegentDegreesRequest

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

export class RegentDegreeResponse
{
    public id: number;
    public program_code: string;
    public program_name: string;
    public concentration_code: string;
    public concentration_name: string;
    public graduation_month?: string;
    public start_date?: string;
    public end_date?: string;
    public gpa?: number;
    public academic_level: string;
    public commencement_date?: string;
    public added_date?: string;
    public added_by: string;
    public changed_date?: string;
    public changed_by: string;
    public timestamp: string;

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

export class ProgramResponse
{
    public responseStatus: ResponseStatus;
    public id: number;
    public program_code: string;
    public program_pretty_code: string;
    public program_long_name: string;
    public available_concentrations: string;
    public is_active: boolean;
    public timestamp: string;

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

export class ConcentrationResponse
{
    public responseStatus: ResponseStatus;
    public id: number;
    public concentration_code: string;
    public concentration_name: string;
    public is_active: boolean;

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

export class CatalogResponse
{
    public responseStatus: ResponseStatus;
    public id: number;
    public catalog_code: string;

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

export class RegentDegreesResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public regent_degrees: RegentDegreeResponse[];
    public valid_programs: ProgramResponse[];
    public valid_concentrations: ConcentrationResponse[];
    public valid_catalogs: CatalogResponse[];

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

export class RegentDegreesRequest
{
    public uuid: string;

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

TypeScript RegentDegreesRequest 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 /Academic/{uuid}/RegentDegrees HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"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"}},"regent_id":0,"uuid":"String","regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"valid_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"program_code":"String","program_pretty_code":"String","program_long_name":"String","available_concentrations":"String","is_active":false,"timestamp":"0001-01-01T00:00:00.0000000"}],"valid_concentrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"concentration_code":"String","concentration_name":"String","is_active":false}],"valid_catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}