regis

<back to all web services

NameHistoryRequest

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

export class NameResponse
{
    public responseStatus: ResponseStatus;
    public first_name: string;
    public last_name: string;
    public middle_name: string;
    public preferred_name: string;
    public prefix: string;
    public created_date?: string;

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

export class NameHistoryResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public names: NameResponse[];

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

export class NameHistoryRequest
{
    public uuid: string;

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

TypeScript NameHistoryRequest 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 /admissions/{uuid}/name/history 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"}},"uuid":"String","regent_id":0,"names":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","prefix":"String","created_date":"0001-01-01T00:00:00.0000000"}]}