regis

<back to all web services

AddressHistoryRequest

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

export class AddressResponse
{
    public responseStatus: ResponseStatus;
    public addr1: string;
    public addr2: string;
    public country: string;
    public country_code: string;
    public state: string;
    public city: string;
    public code: string;
    public start_date?: string;
    public end_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

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

export class PhoneEmailResponse
{
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public email: string;
    public start_date?: string;
    public end_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

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

export class AddressPhoneEmailResponse
{
    public uuid: string;
    public regent_id: number;
    public address: AddressResponse;
    public phone: PhoneEmailResponse;

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

export class AddressHistoryResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public addresses: AddressPhoneEmailResponse[];

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

export class AddressHistoryRequest
{
    public uuid: string;

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

TypeScript AddressHistoryRequest 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}/address/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,"addresses":[{"uuid":"String","regent_id":0,"address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_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"},"phone":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_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"}}]}