regis

<back to all web services

AddressAndBioRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressAndBio
import java.math.*
import java.util.*
import net.servicestack.client.*


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

open class AddressAndBioResponse
{
    var responseStatus:ResponseStatus? = null
    var person:PersonExtendedResponse? = null
    var picture:PersonPictureResponse? = null
    var countriesAndStates:ArrayList<CountriesAndStatesResponse> = ArrayList<CountriesAndStatesResponse>()
    var prefixes:ArrayList<PrefixResponse> = ArrayList<PrefixResponse>()
    var maritalStatuses:HashMap<String,String> = HashMap<String,String>()
    var occupations:ArrayList<Occupation> = ArrayList<Occupation>()
    var denominations:ArrayList<Denomination> = ArrayList<Denomination>()
    var ethnicities:ArrayList<Ethnicity> = ArrayList<Ethnicity>()
}

open class PersonExtendedResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var ubc_id:Int? = null
    var spouse_regent_id:Int? = null
    var uuid:String? = null
    var regent_login:String? = null
    var spouse_rwl:String? = null
    var first_name:String? = null
    var middle_name:String? = null
    var last_name:String? = null
    var preferred_name:String? = null
    var birth_name:String? = null
    var override_transcript_name:String? = null
    var spouse_name:String? = null
    var addr1:String? = null
    var addr2:String? = null
    var country:String? = null
    var state:String? = null
    var city:String? = null
    var code:String? = null
    var phone_home:String? = null
    var phone_cell:String? = null
    var phone_bus:String? = null
    var email:String? = null
    var prefix:String? = null
    var dob:Date? = null
    var citizenship:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var denomination:String? = null
    var occupation:String? = null
    var ethnicity:String? = null
    var gender:String? = null
    var marital_status:String? = null
    var deceased_date:Date? = null
    var is_donor:Boolean? = null
    var is_vendor:Boolean? = null
    var is_gp_customer:Boolean? = null
    var crm_student_status:String? = null
    var crm_assigned:String? = null
    var last_registered_term:String? = null
    var is_regent_staff:Boolean? = null
    var regent_title:String? = null
    var regent_department:String? = null
    var regent_faculty_profile_url:String? = null
    var regent_image_url:String? = null
    var include_on_website:Boolean? = null
    var added_by:String? = null
    var added_date:Date? = null
    var last_changed_by:String? = null
    var last_changed_date:Date? = null
    var addr_last_changed_by:String? = null
    var addr_last_changed_date:Date? = null
    var tax_number:String? = null
    var regent_current_program:String? = null
    var regent_degrees:String? = null
}

open class PersonPictureResponse
{
    var responseStatus:ResponseStatus? = null
    var imageBase64:String? = null
}

open class CountriesAndStatesResponse
{
    var country_code:String? = null
    var country_name:String? = null
    var states:HashMap<String,String> = HashMap<String,String>()
}

open class PrefixResponse
{
    var prefix_code:String? = null
    var prefix_name:String? = null
}

open class Occupation
{
    var id:Int? = null
    var code:String? = null
    var occupation_name:String? = null
}

open class Denomination
{
    var id:Int? = null
    var code:String? = null
    var denomination_name:String? = null
}

open class Ethnicity
{
    var id:Int? = null
    var code:String? = null
    var ethnicity_name:String? = null
}

Kotlin AddressAndBioRequest 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 /person/{uuid}/addressAndBio 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"}},"person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"spouse_regent_id":0,"uuid":"String","regent_login":"String","spouse_rwl":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","override_transcript_name":"String","spouse_name":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","denomination":"String","occupation":"String","ethnicity":"String","gender":"String","marital_status":"String","deceased_date":"0001-01-01T00:00:00.0000000","is_donor":false,"is_vendor":false,"is_gp_customer":false,"crm_student_status":"String","crm_assigned":"String","last_registered_term":"String","is_regent_staff":false,"regent_title":"String","regent_department":"String","regent_faculty_profile_url":"String","regent_image_url":"String","include_on_website":false,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","last_changed_by":"String","last_changed_date":"0001-01-01T00:00:00.0000000","addr_last_changed_by":"String","addr_last_changed_date":"0001-01-01T00:00:00.0000000","tax_number":"String","regent_current_program":"String","regent_degrees":"String"},"picture":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"imageBase64":"String"},"countriesAndStates":[{"country_code":"String","country_name":"String","states":{"String":"String"}}],"prefixes":[{"prefix_code":"String","prefix_name":"String"}],"maritalStatuses":{"String":"String"},"occupations":[{"id":0,"code":"String","occupation_name":"String"}],"denominations":[{"id":0,"code":"String","denomination_name":"String"}],"ethnicities":[{"id":0,"code":"String","ethnicity_name":"String"}]}