Required role: | REGISUserRole |
POST | /admissions/{uuid}/bio/sync |
---|
import Foundation
import ServiceStack
public class BioSyncRequest : Codable
{
public var uuid:String
required public init(){}
}
public class BioSyncResponse : Codable
{
public var responseStatus:ResponseStatus
public var uuid:String
public var regent_id:Int
public var sugar_bio:BioResponse
public var regis_bio:BioResponse
public var re_bio:BioResponse
public var exists_in_sugar:Bool
public var exists_in_re:Bool
public var are_equal:Bool
public var first_name_are_equal:Bool
public var middle_name_are_equal:Bool
public var last_name_are_equal:Bool
public var preferred_name_are_equal:Bool
public var birth_name_are_equal:Bool
public var prefix_are_equal:Bool
public var dob_are_equal:Bool
public var deceased_are_equal:Bool
public var citizenship_are_equal:Bool
public var gender_are_equal:Bool
public var marital_status_are_equal:Bool
required public init(){}
}
public class BioResponse : Codable
{
public var responseStatus:ResponseStatus
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 `prefix`:String
public var dob:Date?
public var citizenship:String
public var citizenship_code:String
public var citizenship_other:String
public var permanent_resident:String
public var citizenship_other_code:String
public var permanent_resident_code:String
public var gender:String
public var gender_code:String
public var marital_status:String
public var marital_status_code:String
public var deceased_date:Date?
public var added_by:String
public var added_date:Date?
public var changed_by:String
public var changed_date:Date?
required public init(){}
}
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 /admissions/{uuid}/bio/sync 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 } }, uuid: String, regent_id: 0, sugar_bio: { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, first_name: String, middle_name: String, last_name: String, preferred_name: String, birth_name: String, prefix: String, dob: 0001-01-01, citizenship: String, citizenship_code: String, citizenship_other: String, permanent_resident: String, citizenship_other_code: String, permanent_resident_code: String, gender: String, gender_code: String, marital_status: String, marital_status_code: String, deceased_date: 0001-01-01, added_by: String, added_date: 0001-01-01, changed_by: String, changed_date: 0001-01-01 }, regis_bio: { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, first_name: String, middle_name: String, last_name: String, preferred_name: String, birth_name: String, prefix: String, dob: 0001-01-01, citizenship: String, citizenship_code: String, citizenship_other: String, permanent_resident: String, citizenship_other_code: String, permanent_resident_code: String, gender: String, gender_code: String, marital_status: String, marital_status_code: String, deceased_date: 0001-01-01, added_by: String, added_date: 0001-01-01, changed_by: String, changed_date: 0001-01-01 }, re_bio: { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, first_name: String, middle_name: String, last_name: String, preferred_name: String, birth_name: String, prefix: String, dob: 0001-01-01, citizenship: String, citizenship_code: String, citizenship_other: String, permanent_resident: String, citizenship_other_code: String, permanent_resident_code: String, gender: String, gender_code: String, marital_status: String, marital_status_code: String, deceased_date: 0001-01-01, added_by: String, added_date: 0001-01-01, changed_by: String, changed_date: 0001-01-01 }, exists_in_sugar: False, exists_in_re: False, are_equal: False, first_name_are_equal: False, middle_name_are_equal: False, last_name_are_equal: False, preferred_name_are_equal: False, birth_name_are_equal: False, prefix_are_equal: False, dob_are_equal: False, deceased_are_equal: False, citizenship_are_equal: False, gender_are_equal: False, marital_status_are_equal: False }