Required permission: | SearchPerson |
POST | /person/{uuid}/extended |
---|
import Foundation
import ServiceStack
public class PersonExtendedRequest : Codable
{
public var uuid:String
required public init(){}
}
public class PersonExtendedResponse : Codable
{
public var responseStatus:ResponseStatus
public var regent_id:Int
public var ubc_id:Int?
public var spouse_regent_id:Int?
public var uuid:String
public var regent_login:String
public var spouse_rwl:String
public var first_name:String
public var middle_name:String
public var last_name:String
public var preferred_name:String
public var birth_name:String
public var override_transcript_name:String
public var spouse_name:String
public var addr1:String
public var addr2:String
public var country:String
public var state:String
public var city:String
public var code:String
public var phone_home:String
public var phone_cell:String
public var phone_bus:String
public var email:String
public var `prefix`:String
public var dob:Date?
public var citizenship:String
public var citizenship_other:String
public var permanent_resident:String
public var denomination:String
public var occupation:String
public var ethnicity:String
public var gender:String
public var marital_status:String
public var deceased_date:Date?
public var is_donor:Bool
public var is_vendor:Bool
public var is_gp_customer:Bool
public var crm_student_status:String
public var crm_assigned:String
public var last_registered_term:String
public var is_regent_staff:Bool
public var regent_title:String
public var regent_department:String
public var regent_faculty_profile_url:String
public var regent_image_url:String
public var include_on_website:Bool
public var added_by:String
public var added_date:Date?
public var last_changed_by:String
public var last_changed_date:Date?
public var addr_last_changed_by:String
public var addr_last_changed_date:Date?
public var tax_number:String
public var regent_current_program:String
public var regent_degrees:String
required public init(){}
}
Swift PersonExtendedRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/extended HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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-01, citizenship: String, citizenship_other: String, permanent_resident: String, denomination: String, occupation: String, ethnicity: String, gender: String, marital_status: String, deceased_date: 0001-01-01, 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-01, last_changed_by: String, last_changed_date: 0001-01-01, addr_last_changed_by: String, addr_last_changed_date: 0001-01-01, tax_number: String, regent_current_program: String, regent_degrees: String }