regis

<back to all web services

StudentTransferCredentialsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}
StudentTransferCredentialsRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
StudentTransferCredentialsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
studentTransferCredentialPackageformList<StudentTransferCredentialPackageResponse>No
StudentTransferCredentialPackageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
equivalent_idformintNo
is_advanced_standingformboolNo
institutionformInstitutionResponseNo
studentAcademicCredentialsformList<StudentAcademicCredentialResponse>No
studentTransferCredentialsformList<StudentTransferCredentialResponse>No
InstitutionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
institution_idformintNo
institution_nameformstringNo
institution_previous_namesformstringNo
institution_other_namesformstringNo
institution_typeformstringNo
accreditation_statusformstringNo
accreditation_status_notesformstringNo
related_institutionsformList<string>No
accreditation_status_changed_dateformDateTime?No
gpa_conversionformstringNo
credit_hour_conversionformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
zipformstringNo
StudentAcademicCredentialResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
stac_uuidformstringNo
section_idformint?No
course_nameformstringNo
section_codeformstringNo
subjectformstringNo
course_levelformint?No
titleformstringNo
pretty_titleformstringNo
locationformstringNo
is_audioformboolNo
is_oncampusformboolNo
credit_valueformdecimal?No
audit_valueformdecimal?No
is_auditformboolNo
is_pass_failformboolNo
gradeformstringNo
is_grade_finalformboolNo
gpa_creditsformdecimal?No
grade_pointsformdecimal?No
academic_levelformstringNo
printed_commentsformstringNo
termformstringNo
reporting_termformstringNo
reporting_yearformint?No
current_statusformstringNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
StudentTransferCredentialResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
stran_uuidformstringNo
course_nameformstringNo
titleformstringNo
credit_valueformdecimal?No
is_advanced_standingformboolNo
equivalent_idformintNo
institution_idformintNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No

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"}]}]}