regis

<back to all web services

BioHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/history

export class BioResponse
{
    public responseStatus: ResponseStatus;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_name: string;
    public prefix: string;
    public dob?: string;
    public citizenship: string;
    public citizenship_code: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public citizenship_other_code: string;
    public permanent_resident_code: string;
    public gender: string;
    public gender_code: string;
    public marital_status: string;
    public marital_status_code: string;
    public deceased_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

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

export class BioHistoryResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public bios: BioResponse[];

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

export class BioHistoryRequest
{
    public uuid: string;

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

TypeScript BioHistoryRequest 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 /admissions/{uuid}/bio/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"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"}},"uuid":"String","regent_id":0,"bios":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}