regis

<back to all web services

InstitutionStudentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/{institution_id}/Students
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class InstitutionStudentsRequest
            Public Overridable Property institution_id As Integer
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class ExternalDegreeResponse
            Public Overridable Property id As Nullable(Of Integer)
            Public Overridable Property institution_id As Nullable(Of Integer)
            Public Overridable Property degree_name As String
            Public Overridable Property degree_override_name As String
            Public Overridable Property institution_name As String
            Public Overridable Property graduation_month As String
            Public Overridable Property start_year As Nullable(Of Integer)
            Public Overridable Property end_year As Nullable(Of Integer)
            Public Overridable Property is_only_in_d365 As Boolean
        End Class

        Public Partial Class ExternalDegreesAdminResponse
            Public Overridable Property degree_code As String
            Public Overridable Property degree_name As String
            Public Overridable Property degree_type As String
        End Class

        Public Partial Class ExternalDegreesResponse
            Public Sub New()
                student_programs = New List(Of StudentProgramSimpleResponse)
                degrees = New List(Of ExternalDegreeResponse)
                valid_degrees = New List(Of ExternalDegreesAdminResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property person As PersonSimpleResponse
            Public Overridable Property gpa As Nullable(Of Decimal)
            Public Overridable Property student_programs As List(Of StudentProgramSimpleResponse)
            Public Overridable Property degrees As List(Of ExternalDegreeResponse)
            Public Overridable Property valid_degrees As List(Of ExternalDegreesAdminResponse)
        End Class

        Public Partial Class InstitutionResponse
            Public Sub New()
                related_institutions = New List(Of String)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property institution_id As Integer
            Public Overridable Property institution_name As String
            Public Overridable Property institution_previous_names As String
            Public Overridable Property institution_other_names As String
            Public Overridable Property institution_type As String
            Public Overridable Property accreditation_status As String
            Public Overridable Property accreditation_status_notes As String
            Public Overridable Property related_institutions As List(Of String)
            Public Overridable Property accreditation_status_changed_date As Nullable(Of Date)
            Public Overridable Property gpa_conversion As String
            Public Overridable Property credit_hour_conversion As String
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property zip As String
        End Class

        Public Partial Class InstitutionStudentsResponse
            Inherits InstitutionResponse
            Public Sub New()
                student_transfer_credentials = New List(Of StudentTransferCredentialsResponse)
                student_previous_degrees = New List(Of ExternalDegreesResponse)
            End Sub

            Public Overridable Property student_transfer_credentials As List(Of StudentTransferCredentialsResponse)
            Public Overridable Property student_previous_degrees As List(Of ExternalDegreesResponse)
        End Class

        Public Partial Class PersonSimpleResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property ubc_id As Nullable(Of Integer)
            Public Overridable Property uuid As String
            Public Overridable Property regent_login As String
            Public Overridable Property first_name As String
            Public Overridable Property preferred_name As String
            Public Overridable Property middle_name As String
            Public Overridable Property last_name As String
            Public Overridable Property email As String
            Public Overridable Property phone_home As String
            Public Overridable Property phone_cell As String
            Public Overridable Property phone_bus As String
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property code As String
            Public Overridable Property citizenship As String
            Public Overridable Property citizenship_other As String
            Public Overridable Property permanent_resident As String
            Public Overridable Property dob As Nullable(Of Date)
            Public Overridable Property is_student As Boolean
            Public Overridable Property is_faculty As Boolean
            Public Overridable Property is_vendor As Boolean
        End Class

        Public Partial Class StudentAcademicCredentialResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property uuid As String
            Public Overridable Property stac_uuid As String
            Public Overridable Property section_id As Nullable(Of Integer)
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property subject As String
            Public Overridable Property course_level As Nullable(Of Integer)
            Public Overridable Property title As String
            Public Overridable Property pretty_title As String
            Public Overridable Property location As String
            Public Overridable Property is_audio As Boolean
            Public Overridable Property is_oncampus As Boolean
            Public Overridable Property credit_value As Nullable(Of Decimal)
            Public Overridable Property audit_value As Nullable(Of Decimal)
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property grade As String
            Public Overridable Property is_grade_final As Boolean
            Public Overridable Property gpa_credits As Nullable(Of Decimal)
            Public Overridable Property grade_points As Nullable(Of Decimal)
            Public Overridable Property academic_level As String
            Public Overridable Property printed_comments As String
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Nullable(Of Integer)
            Public Overridable Property current_status As String
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class StudentProgramSimpleResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property program_id As Integer
            Public Overridable Property program_code As String
            Public Overridable Property program_name As String
            Public Overridable Property concentration_code As String
            Public Overridable Property concentration_name As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property catalog As String
            Public Overridable Property is_active As Boolean
            Public Overridable Property is_graduated As Boolean
        End Class

        Public Partial Class StudentTransferCredentialPackageResponse
            Public Sub New()
                studentAcademicCredentials = New List(Of StudentAcademicCredentialResponse)
                studentTransferCredentials = New List(Of StudentTransferCredentialResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property equivalent_id As Integer
            Public Overridable Property is_advanced_standing As Boolean
            Public Overridable Property institution As InstitutionResponse
            Public Overridable Property studentAcademicCredentials As List(Of StudentAcademicCredentialResponse)
            Public Overridable Property studentTransferCredentials As List(Of StudentTransferCredentialResponse)
        End Class

        Public Partial Class StudentTransferCredentialResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property uuid As String
            Public Overridable Property stran_uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property title As String
            Public Overridable Property credit_value As Nullable(Of Decimal)
            Public Overridable Property is_advanced_standing As Boolean
            Public Overridable Property equivalent_id As Integer
            Public Overridable Property institution_id As Integer
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class StudentTransferCredentialsResponse
            Public Sub New()
                studentTransferCredentialPackage = New List(Of StudentTransferCredentialPackageResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property studentTransferCredentialPackage As List(Of StudentTransferCredentialPackageResponse)
        End Class
    End Namespace
End Namespace

VB.NET InstitutionStudentsRequest 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/Institution/{institution_id}/Students HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"institution_id":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"student_transfer_credentials":[{"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","studentTransferCredentialPackage":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"equivalent_id":0,"is_advanced_standing":false,"institution":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"},"studentAcademicCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","pretty_title":"String","location":"String","is_audio":false,"is_oncampus":false,"credit_value":0,"audit_value":0,"is_audit":false,"is_pass_fail":false,"grade":"String","is_grade_final":false,"gpa_credits":0,"grade_points":0,"academic_level":"String","printed_comments":"String","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"studentTransferCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stran_uuid":"String","course_name":"String","title":"String","credit_value":0,"is_advanced_standing":false,"equivalent_id":0,"institution_id":0,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}]}],"student_previous_degrees":[{"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"}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}