regis

<back to all web services

StudentTransferCredentialsRequest

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

public class StudentTransferCredentialsRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class StudentTransferCredentialsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var studentTransferCredentialPackage:[StudentTransferCredentialPackageResponse] = []

    required public init(){}
}

public class StudentTransferCredentialPackageResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var equivalent_id:Int
    public var is_advanced_standing:Bool
    public var institution:InstitutionResponse
    public var studentAcademicCredentials:[StudentAcademicCredentialResponse] = []
    public var studentTransferCredentials:[StudentTransferCredentialResponse] = []

    required public init(){}
}

public class InstitutionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var institution_id:Int
    public var institution_name:String
    public var institution_previous_names:String
    public var institution_other_names:String
    public var institution_type:String
    public var accreditation_status:String
    public var accreditation_status_notes:String
    public var related_institutions:[String] = []
    public var accreditation_status_changed_date:Date?
    public var gpa_conversion:String
    public var credit_hour_conversion:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var country:String
    public var zip:String

    required public init(){}
}

public class StudentAcademicCredentialResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var stac_uuid:String
    public var section_id:Int?
    public var course_name:String
    public var section_code:String
    public var subject:String
    public var course_level:Int?
    public var title:String
    public var pretty_title:String
    public var location:String
    public var is_audio:Bool
    public var is_oncampus:Bool
    public var credit_value:Double?
    public var audit_value:Double?
    public var is_audit:Bool
    public var is_pass_fail:Bool
    public var grade:String
    public var is_grade_final:Bool
    public var gpa_credits:Double?
    public var grade_points:Double?
    public var academic_level:String
    public var printed_comments:String
    public var term:String
    public var reporting_term:String
    public var reporting_year:Int?
    public var current_status:String
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?

    required public init(){}
}

public class StudentTransferCredentialResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var stran_uuid:String
    public var course_name:String
    public var title:String
    public var credit_value:Double?
    public var is_advanced_standing:Bool
    public var equivalent_id:Int
    public var institution_id:Int
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?

    required public init(){}
}

Swift StudentTransferCredentialsRequest 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 /StudentTransferCredentials/{uuid} 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","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"}]}]}