regis

<back to all web services

RegentDegreesRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/RegentDegrees
RegentDegreesRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
RegentDegreesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
regent_degreesformList<RegentDegreeResponse>No
valid_programsformList<ProgramResponse>No
valid_concentrationsformList<ConcentrationResponse>No
valid_catalogsformList<CatalogResponse>No
RegentDegreeResponse Parameters:
NameParameterData TypeRequiredDescription
idformintNo
program_codeformstringNo
program_nameformstringNo
concentration_codeformstringNo
concentration_nameformstringNo
graduation_monthformDateTime?No
start_dateformDateTime?No
end_dateformDateTime?No
gpaformdecimal?No
academic_levelformstringNo
commencement_dateformDateTime?No
added_dateformDateTime?No
added_byformstringNo
changed_dateformDateTime?No
changed_byformstringNo
timestampformDateTimeNo
ProgramResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
idformintNo
program_codeformstringNo
program_pretty_codeformstringNo
program_long_nameformstringNo
available_concentrationsformstringNo
is_activeformboolNo
timestampformDateTimeNo
ConcentrationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
idformintNo
concentration_codeformstringNo
concentration_nameformstringNo
is_activeformboolNo
CatalogResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
idformintNo
catalog_codeformstringNo

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/{uuid}/RegentDegrees HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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","regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"valid_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"program_code":"String","program_pretty_code":"String","program_long_name":"String","available_concentrations":"String","is_active":false,"timestamp":"0001-01-01T00:00:00.0000000"}],"valid_concentrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"concentration_code":"String","concentration_name":"String","is_active":false}],"valid_catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}