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
"use strict";
export class AddressResponse {
    /** @param {{responseStatus?:ResponseStatus,addr1?:string,addr2?:string,country?:string,country_code?:string,state?:string,city?:string,code?:string,start_date?:string,end_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    country;
    /** @type {string} */
    country_code;
    /** @type {string} */
    state;
    /** @type {string} */
    city;
    /** @type {string} */
    code;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class PhoneEmailResponse {
    /** @param {{phone_home?:string,phone_cell?:string,phone_bus?:string,email?:string,start_date?:string,end_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    email;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class AddressPhoneEmailResponse {
    /** @param {{uuid?:string,regent_id?:number,address?:AddressResponse,phone?:PhoneEmailResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {AddressResponse} */
    address;
    /** @type {PhoneEmailResponse} */
    phone;
}
export class AddressHistoryResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,addresses?:AddressPhoneEmailResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {AddressPhoneEmailResponse[]} */
    addresses;
}
export class AddressHistoryRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript AddressHistoryRequest 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}/address/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,"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"}}]}