regis

<back to all web services

PersonSideBarRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/sidebar
import Foundation
import ServiceStack

public class PersonSideBarRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class PersonSideBarResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var ubc_id:Int?
    public var regent_login:String
    public var uuid:String
    public var first_name:String
    public var middle_name:String
    public var last_name:String
    public var preferred_name:String
    public var dob:Date?
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var code:String
    public var country:String
    public var email:String
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var imageBase64:String
    public var tax_number:String
    public var programs:[StudentProgramSimpleResponse] = []

    required public init(){}
}

public class StudentProgramSimpleResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var program_id:Int
    public var program_code:String
    public var program_name:String
    public var concentration_code:String
    public var concentration_name:String
    public var start_date:Date?
    public var end_date:Date?
    public var catalog:String
    public var is_active:Bool
    public var is_graduated:Bool

    required public init(){}
}


Swift PersonSideBarRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /person/{uuid}/sidebar HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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,"regent_login":"String","uuid":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","addr1":"String","addr2":"String","city":"String","state":"String","code":"String","country":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","imageBase64":"String","tax_number":"String","programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}]}