regis

<back to all web services

RegistrationSummaryRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/registration/summary
import Foundation
import ServiceStack

public class RegistrationSummaryRequest : Codable
{
    public var uuid:String
    public var from_this_term:String

    required public init(){}
}

public class RegistrationSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var is_missing_tax_number:Bool
    public var person:PersonSimpleResponse
    public var registrations:[StudentAcademicCredentialByReportingTermSimpleResponse] = []
    public var provisional_registrations:ProvisionalRegistrationsForStudentResponse

    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 StudentAcademicCredentialByReportingTermSimpleResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var reportingTerm:String
    public var onlineCreditsAttempted:Double
    public var onlineAuditsAttempted:Double
    public var studentAcademicCredentialSimpleResponse:[StudentAcademicCredentialSimpleResponse] = []

    required public init(){}
}

public class StudentAcademicCredentialSimpleResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var course_uuid:String
    public var course_name:String
    public var section_code:String
    public var section_id:Int?
    public var term:String
    public var reporting_term:String
    public var title:String
    public var amount:Double?
    public var is_audit:Bool
    public var is_pass_fail:Bool
    public var is_graded:Bool

    required public init(){}
}

public class ProvisionalRegistrationsForStudentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var provisional_registrations:[ProvisionalRegistrationResponse] = []

    required public init(){}
}

public class ProvisionalRegistrationResponse : Codable
{
    public var uuid:String
    public var regent_id:Int?
    public var student_name:String
    public var email:String
    public var section_uuid:String
    public var student_section_uuid:String
    public var course_name:String
    public var section_code:String
    public var title:String
    public var term:String
    public var amount:Double
    public var is_audit:Bool
    public var is_waitlist:Bool
    public var is_missing_requisites:Bool
    public var is_other_restriction:Bool
    public var documents:[RegistrationDocumentResponse] = []
    public var requested_date:Date

    required public init(){}
}

public class RegistrationDocumentResponse : Codable
{
    public var uuid:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var gender:String
    public var email:String
    public var program:String
    public var concentration:String
    public var section_uuid:String
    public var course_name:String
    public var course_title:String
    public var reporting_term:String
    public var document_code:String
    public var document_json:String
    public var document_name:String
    public var document_description:String
    public var added_date:Date?
    public var changed_date:Date?

    required public init(){}
}

Swift RegistrationSummaryRequest 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 /registration/summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","from_this_term":"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","is_missing_tax_number":false,"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},"registrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reportingTerm":"String","onlineCreditsAttempted":0,"onlineAuditsAttempted":0,"studentAcademicCredentialSimpleResponse":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"course_uuid":"String","course_name":"String","section_code":"String","section_id":0,"term":"String","reporting_term":"String","title":"String","amount":0,"is_audit":false,"is_pass_fail":false,"is_graded":false}]}],"provisional_registrations":{"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","provisional_registrations":[{"uuid":"String","regent_id":0,"student_name":"String","email":"String","section_uuid":"String","student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_waitlist":false,"is_missing_requisites":false,"is_other_restriction":false,"documents":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"requested_date":"0001-01-01T00:00:00.0000000"}]}}