regis

<back to all web services

ExternalDegreesRequest

Requires Authentication
Required permission:ReadExternalDegrees
The following routes are available for this service:
POST/Academic/{uuid}/ExternalDegrees
import Foundation
import ServiceStack

public class ExternalDegreesRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class ExternalDegreesResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var person:PersonSimpleResponse
    public var gpa:Double?
    public var student_programs:[StudentProgramSimpleResponse] = []
    public var degrees:[ExternalDegreeResponse] = []
    public var valid_degrees:[ExternalDegreesAdminResponse] = []

    required public init(){}
}

public class PersonSimpleResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var ubc_id:Int?
    public var uuid:String
    public var regent_login:String
    public var first_name:String
    public var preferred_name:String
    public var middle_name:String
    public var last_name:String
    public var email:String
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var country:String
    public var code:String
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var dob:Date?
    public var is_student:Bool
    public var is_faculty:Bool
    public var is_vendor:Bool

    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(){}
}

public class ExternalDegreeResponse : Codable
{
    public var id:Int?
    public var institution_id:Int?
    public var degree_name:String
    public var degree_override_name:String
    public var institution_name:String
    public var graduation_month:String
    public var start_year:Int?
    public var end_year:Int?
    public var is_only_in_d365:Bool

    required public init(){}
}

public class ExternalDegreesAdminResponse : Codable
{
    public var degree_code:String
    public var degree_name:String
    public var degree_type:String

    required public init(){}
}


Swift ExternalDegreesRequest 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 /Academic/{uuid}/ExternalDegrees 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,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false},"gpa":0,"student_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}],"degrees":[{"id":0,"institution_id":0,"degree_name":"String","degree_override_name":"String","institution_name":"String","graduation_month":"String","start_year":0,"end_year":0,"is_only_in_d365":false}],"valid_degrees":[{"degree_code":"String","degree_name":"String","degree_type":"String"}]}