| Required role: | REGISUserRole |
| POST | /Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | No | |
| transaction_uuid | path | string | No | |
| reporting_term | path | string | No | |
| audio_only | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| transaction_uuid | form | string | No | |
| regent_id | form | int | No | |
| uuid | form | string | No | |
| reporting_term | form | string | No | |
| numberOfStudentSections | form | int | No | |
| amountOwing | form | decimal | No | |
| mustPayBeforeRegistering | form | bool | No | |
| requiredDocuments | form | List<RegistrationDocumentResponse> | No | |
| completedDocuments | form | List<RegistrationDocumentResponse> | No | |
| isLate | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| uuid | form | string | No | |
| regent_id | form | int | No | |
| first_name | form | string | No | |
| last_name | form | string | No | |
| gender | form | string | No | |
| form | string | No | ||
| program | form | string | No | |
| concentration | form | string | No | |
| section_uuid | form | string | No | |
| course_name | form | string | No | |
| course_title | form | string | No | |
| reporting_term | form | string | No | |
| document_code | form | string | No | |
| document_json | form | string | No | |
| document_name | form | string | No | |
| document_description | form | string | No | |
| added_date | form | DateTime? | No | |
| changed_date | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
transaction_uuid: String,
reporting_term: String,
audio_only: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
changed_date: 0001-01-01
}
],
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-01,
changed_date: 0001-01-01
}
],
isLate: False
}