regis

<back to all web services

RegentDegreesRequest

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

public class RegentDegreesRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class RegentDegreesResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var regent_degrees:[RegentDegreeResponse] = []
    public var valid_programs:[ProgramResponse] = []
    public var valid_concentrations:[ConcentrationResponse] = []
    public var valid_catalogs:[CatalogResponse] = []

    required public init(){}
}

public class RegentDegreeResponse : Codable
{
    public var id:Int
    public var program_code:String
    public var program_name:String
    public var concentration_code:String
    public var concentration_name:String
    public var graduation_month:Date?
    public var start_date:Date?
    public var end_date:Date?
    public var gpa:Double?
    public var academic_level:String
    public var commencement_date:Date?
    public var added_date:Date?
    public var added_by:String
    public var changed_date:Date?
    public var changed_by:String
    public var timestamp:Date

    required public init(){}
}

public class ProgramResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var id:Int
    public var program_code:String
    public var program_pretty_code:String
    public var program_long_name:String
    public var available_concentrations:String
    public var is_active:Bool
    public var timestamp:Date

    required public init(){}
}

public class ConcentrationResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var id:Int
    public var concentration_code:String
    public var concentration_name:String
    public var is_active:Bool

    required public init(){}
}

public class CatalogResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var id:Int
    public var catalog_code:String

    required public init(){}
}


Swift RegentDegreesRequest 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}/RegentDegrees 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"}},"regent_id":0,"uuid":"String","regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"valid_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"program_code":"String","program_pretty_code":"String","program_long_name":"String","available_concentrations":"String","is_active":false,"timestamp":"0001-01-01T00:00:00.0000000"}],"valid_concentrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"concentration_code":"String","concentration_name":"String","is_active":false}],"valid_catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}