regis

PersonSideBarRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/{uuid}/sidebar


export class StudentProgramSimpleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public program_id: number;
    public program_code: string;
    public program_name: string;
    public concentration_code: string;
    public concentration_name: string;
    public start_date?: string;
    public end_date?: string;
    public catalog: string;
    public is_active: boolean;
    public is_graduated: boolean;

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

export class PersonSideBarResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public ubc_id?: number;
    public regent_login: string;
    public uuid: string;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public dob?: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public code: string;
    public country: string;
    public email: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public imageBase64: string;
    public tax_number: string;
    public programs: StudentProgramSimpleResponse[];

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

export class PersonSideBarRequest
{
    public uuid: string;

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

TypeScript PersonSideBarRequest 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 /person/{uuid}/sidebar 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,"ubc_id":0,"regent_login":"String","uuid":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","addr1":"String","addr2":"String","city":"String","state":"String","code":"String","country":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","imageBase64":"String","tax_number":"String","programs":[{"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","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}]}