regis

<back to all web services

TermStatementRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TermStatements/{uuid}/{reporting_term}
TermStatementRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
reporting_termpathstringNo
authorizing_uuidbodystringNo
TermStatementResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
nameformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
reporting_termformstringNo
reporting_term_start_dateformDateTimeNo
reporting_term_end_dateformDateTimeNo
academic_programformstringNo
total_term_paymentsformdecimalNo
total_term_chargesformdecimalNo
total_term_taxesformdecimalNo
registrationsformList<TermStatementRegistrationResponse>No
chargesformList<TermStatementChargesResponse>No
TermStatementRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
course_nameformstringNo
titleformstringNo
section_codeformstringNo
amountformdecimalNo
is_auditformboolNo
meeting_daysformstringNo
timesformstringNo
roomformstringNo
instructorformstringNo
statusformstringNo
costformdecimalNo
start_dateformDateTime?No
end_dateformDateTime?No
TermStatementChargesResponse Parameters:
NameParameterData TypeRequiredDescription
dateformDateTimeNo
codeformstringNo
descriptionformstringNo
is_financial_aidformboolNo
chargeformdecimalNo

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 /TermStatements/{uuid}/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","reporting_term":"String","authorizing_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","name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","reporting_term":"String","reporting_term_start_date":"0001-01-01T00:00:00.0000000","reporting_term_end_date":"0001-01-01T00:00:00.0000000","academic_program":"String","total_term_payments":0,"total_term_charges":0,"total_term_taxes":0,"registrations":[{"course_name":"String","title":"String","section_code":"String","amount":0,"is_audit":false,"meeting_days":"String","times":"String","room":"String","instructor":"String","status":"String","cost":0,"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}],"charges":[{"date":"0001-01-01T00:00:00.0000000","code":"String","description":"String","is_financial_aid":false,"charge":0}]}