regis

<back to all web services

AcademicSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/Summary
AcademicSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
AcademicSummaryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
gpaformdecimal?No
student_programsformList<StudentProgramSimpleResponse>No
unofficial_undergraduate_degree_descriptionformstringNo
messagesformList<string>No
StudentProgramSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
program_idformintNo
program_codeformstringNo
program_nameformstringNo
concentration_codeformstringNo
concentration_nameformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
catalogformstringNo
is_activeformboolNo
is_graduatedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"]}