regis

<back to all web services

PersonSideBarRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/sidebar
"use strict";
export class StudentProgramSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,program_id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,start_date?:string,end_date?:string,catalog?:string,is_active?:boolean,is_graduated?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {number} */
    program_id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_name;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    concentration_name;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    catalog;
    /** @type {boolean} */
    is_active;
    /** @type {boolean} */
    is_graduated;
}
export class PersonSideBarResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,regent_login?:string,uuid?:string,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,dob?:string,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?:StudentProgramSimpleResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    ubc_id;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    uuid;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    code;
    /** @type {string} */
    country;
    /** @type {string} */
    email;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    imageBase64;
    /** @type {string} */
    tax_number;
    /** @type {StudentProgramSimpleResponse[]} */
    programs;
}
export class PersonSideBarRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript 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}]}