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.*


open class AddressHistoryRequest
{
    var uuid:String? = null
}

open class AddressHistoryResponse
{
    var responseStatus:ResponseStatus? = null
    var uuid:String? = null
    var regent_id:Int? = null
    var addresses:ArrayList<AddressPhoneEmailResponse> = ArrayList<AddressPhoneEmailResponse>()
}

open class AddressPhoneEmailResponse
{
    var uuid:String? = null
    var regent_id:Int? = null
    var address:AddressResponse? = null
    var phone:PhoneEmailResponse? = null
}

open class AddressResponse
{
    var responseStatus:ResponseStatus? = null
    var addr1:String? = null
    var addr2:String? = null
    var country:String? = null
    var country_code:String? = null
    var state:String? = null
    var city:String? = null
    var code:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
}

open class PhoneEmailResponse
{
    var phone_home:String? = null
    var phone_cell:String? = null
    var phone_bus:String? = null
    var email:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
}

Kotlin 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"}}]}