| Required role: | REGISUserRole |
| POST | /Registration/Provisional/{student_section_uuid}/Authorize |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| student_section_uuid | path | string | No | |
| authorizing_uuid | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| transaction_uuid | form | string | No | |
| studentSectionInvoiceItems | form | List<StudentSectionInvoiceItemResponse> | No | |
| sectionRates | form | Dictionary<string, List<SectionRateWithAmountResponse>> | No | |
| creditTuitionRate | form | InvoiceItemAdminResponse | No | |
| auditTuitionRate | form | InvoiceItemAdminResponse | No | |
| studentAge | form | int? | No | |
| studentAgeAtEarliestSectionStartDate | form | int? | No | |
| isRegentGrad | form | bool | No | |
| isOnlyUnclassified | form | bool | No | |
| canRegisterForAuditInTerm | form | bool | No | |
| canRegisterForCreditInTerm | form | bool | No | |
| messages | form | List<string> | No | |
| currentTermAuditHours | form | decimal | No | |
| currentTermCreditHours | form | decimal | No | |
| totalCreditHours | form | decimal | No | |
| availableInvoiceItems | form | List<InvoiceItemAdminResponse> | No | |
| availableBenefits | form | List<BenefitResponse> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| invoiceUUID | form | string | No | |
| regent_id | form | int | No | |
| uuid | form | string | No | |
| reporting_term | form | string | No | |
| total_charges | form | decimal? | No | |
| total_credits | form | decimal? | No | |
| current_status | form | string | No | |
| timestamp | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| studentSection | form | StudentSectionResponse | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| invoiceItemUUID | form | string | No | |
| rate_id | form | int | No | |
| rate_code | form | string | No | |
| rate_description | form | string | No | |
| charge | form | decimal? | No | |
| credit | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| studentSectionUUID | form | string | No | |
| registered_amount | form | decimal | No | |
| is_provisional | form | bool | No | |
| is_audit | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| secUUID | form | string | No | |
| course_name | form | string | No | |
| section_code | form | string | No | |
| course_title | form | string | No | |
| course_short_title | form | string | No | |
| course_description | form | string | No | |
| crosslist_description | form | string | No | |
| crosslist_course_name | form | string | No | |
| location_long_name | form | string | No | |
| room | form | string | No | |
| instructors | form | List<InstructorResponse> | No | |
| required_documents | form | List<DocumentResponse> | No | |
| start_date | form | DateTime? | No | |
| end_date | form | DateTime? | No | |
| first_meeting_date | form | DateTime? | No | |
| last_meeting_date | form | DateTime? | No | |
| meeting_days | form | string | No | |
| start_times | form | List<string> | No | |
| end_times | form | List<string> | No | |
| is_online_only | form | bool | No | |
| is_weekend | form | bool | No | |
| is_weekday | form | bool | No | |
| is_evening | form | bool | No | |
| is_waitlist | form | bool | No | |
| has_special_requirements | form | bool | No | |
| special_requirements | form | string | No | |
| is_unlisted | form | bool | No | |
| credit_amounts | form | List<decimal> | No | |
| audit_amounts | form | List<decimal> | No | |
| audits_short_name | form | string | No | |
| audits_long_name | form | string | No | |
| credits_short_name | form | string | No | |
| credits_long_name | form | string | No | |
| distance_ed_materials | form | string | No | |
| prerequisites | form | string | No | |
| corequisites | form | string | No | |
| capacity | form | int? | No | |
| flat_fee_amount | form | decimal? | No | |
| additional_fee_amount | form | decimal? | No | |
| registered_students | form | int | No | |
| three_credit_plus | form | int | No | |
| two_credit | form | int | No | |
| one_credit | form | int | No | |
| three_audit_plus | form | int | No | |
| two_audit | form | int | No | |
| one_audit | form | int | No | |
| crosslist_registered_students | form | int | No | |
| grades_received | form | int | No | |
| crosslist_grades_received | form | int | No | |
| registration_start_date | form | DateTime? | No | |
| registration_end_date | form | DateTime? | No | |
| add_start_date | form | DateTime? | No | |
| add_end_date | form | DateTime? | No | |
| drop_start_date | form | DateTime? | No | |
| drop_end_date | form | DateTime? | No | |
| grading_end_date | form | DateTime? | No | |
| term | form | string | No | |
| reporting_term | form | string | No | |
| reporting_year | form | int | No | |
| current_status | form | string | No | |
| added_by | form | string | No | |
| added_date | form | DateTime? | No | |
| changed_by | form | string | No | |
| changed_date | form | DateTime? | No | |
| timestamp | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int | No | |
| regent_login | form | string | No | |
| preferred_name | form | string | No | |
| first_name | form | string | No | |
| last_name | form | string | No | |
| full_name | form | string | No | |
| form | string | No | ||
| image_base64 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| code | form | string | No | |
| document_name | form | string | No | |
| document_description | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| invoiceItemUUID | form | string | No | |
| rate_id | form | int | No | |
| rate_code | form | string | No | |
| rate_description | form | string | No | |
| is_required | form | bool | No | |
| is_optional | form | bool | No | |
| charge | form | decimal? | No | |
| credit | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| rate_id | form | int | No | |
| rate_code | form | string | No | |
| rate_description | form | string | No | |
| percentage_rate | form | decimal | No | |
| is_optional | form | bool | No | |
| is_required | form | bool | 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/Provisional/{student_section_uuid}/Authorize HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
student_section_uuid: String,
authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
transaction_uuid: String,
studentSectionInvoiceItems:
[
{
studentSection:
{
studentSectionUUID: String,
registered_amount: 0,
is_provisional: False,
is_audit: False,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
secUUID: String,
course_name: String,
section_code: String,
course_title: String,
course_short_title: String,
course_description: String,
crosslist_description: String,
crosslist_course_name: String,
location_long_name: String,
room: String,
instructors:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
regent_login: String,
preferred_name: String,
first_name: String,
last_name: String,
full_name: String,
email: String,
image_base64: String
}
],
required_documents:
[
{
code: String,
document_name: String,
document_description: String
}
],
start_date: 0001-01-01,
end_date: 0001-01-01,
first_meeting_date: 0001-01-01,
last_meeting_date: 0001-01-01,
meeting_days: String,
start_times:
[
String
],
end_times:
[
String
],
is_online_only: False,
is_weekend: False,
is_weekday: False,
is_evening: False,
is_waitlist: False,
has_special_requirements: False,
special_requirements: String,
is_unlisted: False,
credit_amounts:
[
0
],
audit_amounts:
[
0
],
audits_short_name: String,
audits_long_name: String,
credits_short_name: String,
credits_long_name: String,
distance_ed_materials: String,
prerequisites: String,
corequisites: String,
capacity: 0,
flat_fee_amount: 0,
additional_fee_amount: 0,
registered_students: 0,
three_credit_plus: 0,
two_credit: 0,
one_credit: 0,
three_audit_plus: 0,
two_audit: 0,
one_audit: 0,
crosslist_registered_students: 0,
grades_received: 0,
crosslist_grades_received: 0,
registration_start_date: 0001-01-01,
registration_end_date: 0001-01-01,
add_start_date: 0001-01-01,
add_end_date: 0001-01-01,
drop_start_date: 0001-01-01,
drop_end_date: 0001-01-01,
grading_end_date: 0001-01-01,
term: String,
reporting_term: String,
reporting_year: 0,
current_status: String,
added_by: String,
added_date: 0001-01-01,
changed_by: String,
changed_date: 0001-01-01,
timestamp: 0001-01-01
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
charge: 0,
credit: 0
}
],
sectionRates:
{
String:
[
{
rate_id: 0,
charge: 0,
credit: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
uuid: String,
secUUID: String,
section_id: 0,
course_name: String,
section_code: String,
title: String,
reporting_term: String,
rate_code: String,
rate_description: String,
is_override_credit_rate: False,
is_override_audit_rate: False
}
]
},
creditTuitionRate:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
is_required: False,
is_optional: False,
charge: 0,
credit: 0
},
auditTuitionRate:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
is_required: False,
is_optional: False,
charge: 0,
credit: 0
},
studentAge: 0,
studentAgeAtEarliestSectionStartDate: 0,
isRegentGrad: False,
isOnlyUnclassified: False,
canRegisterForAuditInTerm: False,
canRegisterForCreditInTerm: False,
messages:
[
String
],
currentTermAuditHours: 0,
currentTermCreditHours: 0,
totalCreditHours: 0,
availableInvoiceItems:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
is_required: False,
is_optional: False,
charge: 0,
credit: 0
}
],
availableBenefits:
[
{
rate_id: 0,
rate_code: String,
rate_description: String,
percentage_rate: 0,
is_optional: False,
is_required: False
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceUUID: String,
regent_id: 0,
uuid: String,
reporting_term: String,
total_charges: 0,
total_credits: 0,
current_status: String,
timestamp: 0001-01-01
}