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 java.math.*
import java.util.*
import net.servicestack.client.*


open class AcademicSummaryRequest
{
    var uuid:String? = null
}

open class AcademicSummaryResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var gpa:BigDecimal? = null
    var student_programs:ArrayList<StudentProgramSimpleResponse> = ArrayList<StudentProgramSimpleResponse>()
    var unofficial_undergraduate_degree_description:String? = null
    var messages:ArrayList<String> = ArrayList<String>()
}

open class StudentProgramSimpleResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var program_id:Int? = null
    var program_code:String? = null
    var program_name:String? = null
    var concentration_code:String? = null
    var concentration_name:String? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var catalog:String? = null
    var is_active:Boolean? = null
    var is_graduated:Boolean? = null
}

Kotlin AcademicSummaryRequest 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 /Academic/{uuid}/Summary 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,"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"]}