regis

<back to all web services

UnauthenticatedRegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid}
UnauthenticatedRegistrationInProgressSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
transaction_uuidpathstringNo
reporting_termpathstringNo
audio_onlybodyboolNo
RegistrationInProgressSummaryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
transaction_uuidformstringNo
regent_idformintNo
uuidformstringNo
reporting_termformstringNo
numberOfStudentSectionsformintNo
amountOwingformdecimalNo
mustPayBeforeRegisteringformboolNo
requiredDocumentsformList<RegistrationDocumentResponse>No
completedDocumentsformList<RegistrationDocumentResponse>No
isLateformboolNo
RegistrationDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformintNo
first_nameformstringNo
last_nameformstringNo
genderformstringNo
emailformstringNo
programformstringNo
concentrationformstringNo
section_uuidformstringNo
course_nameformstringNo
course_titleformstringNo
reporting_termformstringNo
document_codeformstringNo
document_jsonformstringNo
document_nameformstringNo
document_descriptionformstringNo
added_dateformDateTime?No
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 /Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","transaction_uuid":"String","reporting_term":"String","audio_only":false}
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"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}