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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AddressHistoryRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public AddressHistoryRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class AddressHistoryResponse
    {
        public ResponseStatus responseStatus = null;
        public String uuid = null;
        public Integer regent_id = null;
        public ArrayList<AddressPhoneEmailResponse> addresses = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public AddressHistoryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getUuid() { return uuid; }
        public AddressHistoryResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public AddressHistoryResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public ArrayList<AddressPhoneEmailResponse> getAddresses() { return addresses; }
        public AddressHistoryResponse setAddresses(ArrayList<AddressPhoneEmailResponse> value) { this.addresses = value; return this; }
    }

    public static class AddressPhoneEmailResponse
    {
        public String uuid = null;
        public Integer regent_id = null;
        public AddressResponse address = null;
        public PhoneEmailResponse phone = null;
        
        public String getUuid() { return uuid; }
        public AddressPhoneEmailResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public AddressPhoneEmailResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public AddressResponse getAddress() { return address; }
        public AddressPhoneEmailResponse setAddress(AddressResponse value) { this.address = value; return this; }
        public PhoneEmailResponse getPhone() { return phone; }
        public AddressPhoneEmailResponse setPhone(PhoneEmailResponse value) { this.phone = value; return this; }
    }

    public static class AddressResponse
    {
        public ResponseStatus responseStatus = null;
        public String addr1 = null;
        public String addr2 = null;
        public String country = null;
        public String country_code = null;
        public String state = null;
        public String city = null;
        public String code = null;
        public Date start_date = null;
        public Date end_date = null;
        public String added_by = null;
        public Date added_date = null;
        public String changed_by = null;
        public Date changed_date = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public AddressResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getAddr1() { return addr1; }
        public AddressResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public AddressResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCountry() { return country; }
        public AddressResponse setCountry(String value) { this.country = value; return this; }
        public String getCountryCode() { return country_code; }
        public AddressResponse setCountryCode(String value) { this.country_code = value; return this; }
        public String getState() { return state; }
        public AddressResponse setState(String value) { this.state = value; return this; }
        public String getCity() { return city; }
        public AddressResponse setCity(String value) { this.city = value; return this; }
        public String getCode() { return code; }
        public AddressResponse setCode(String value) { this.code = value; return this; }
        public Date getStartDate() { return start_date; }
        public AddressResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public AddressResponse setEndDate(Date value) { this.end_date = value; return this; }
        public String getAddedBy() { return added_by; }
        public AddressResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getAddedDate() { return added_date; }
        public AddressResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public AddressResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public AddressResponse setChangedDate(Date value) { this.changed_date = value; return this; }
    }

    public static class PhoneEmailResponse
    {
        public String phone_home = null;
        public String phone_cell = null;
        public String phone_bus = null;
        public String email = null;
        public Date start_date = null;
        public Date end_date = null;
        public String added_by = null;
        public Date added_date = null;
        public String changed_by = null;
        public Date changed_date = null;
        
        public String getPhoneHome() { return phone_home; }
        public PhoneEmailResponse setPhoneHome(String value) { this.phone_home = value; return this; }
        public String getPhoneCell() { return phone_cell; }
        public PhoneEmailResponse setPhoneCell(String value) { this.phone_cell = value; return this; }
        public String getPhoneBus() { return phone_bus; }
        public PhoneEmailResponse setPhoneBus(String value) { this.phone_bus = value; return this; }
        public String getEmail() { return email; }
        public PhoneEmailResponse setEmail(String value) { this.email = value; return this; }
        public Date getStartDate() { return start_date; }
        public PhoneEmailResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public PhoneEmailResponse setEndDate(Date value) { this.end_date = value; return this; }
        public String getAddedBy() { return added_by; }
        public PhoneEmailResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getAddedDate() { return added_date; }
        public PhoneEmailResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public PhoneEmailResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public PhoneEmailResponse setChangedDate(Date value) { this.changed_date = value; return this; }
    }

}

Java AddressHistoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}]}