regis

<back to all web services

AcademicSummaryRequest

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

public class AcademicSummaryRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class AcademicSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var gpa:Double?
    public var student_programs:[StudentProgramSimpleResponse] = []
    public var unofficial_undergraduate_degree_description:String
    public var messages:[String] = []

    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 AcademicSummaryRequest DTOs

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

HTTP + OTHER

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

POST /Academic/{uuid}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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","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}],"unofficial_undergraduate_degree_description":"String","messages":["String"]}