Required role: | REGISUserRole |
POST | /Registration/{uuid}/Add/{reporting_term}/Submit |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
transaction_uuid | body | string | No | |
uuid | path | string | No | |
reporting_term | path | string | No | |
description | body | string | No | |
email_student | body | bool | No | |
registrations | body | List<AddRegistrationWithBenefitRequest> | No | |
additional_term_charges | body | List<AddRegistrationsAdditionalChargeSubmitRequest> | No | |
authorizing_uuid | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
student_section_uuid | form | string | No | |
description | form | string | No | |
amount | form | decimal | No | |
charge | form | decimal | No | |
is_audit | form | bool | No | |
benefit_id | form | int? | No | |
benefit_amount | form | decimal? | No | |
second_benefit_id | form | int? | No | |
second_benefit_amount | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
rate_id | form | int | No | |
description | form | string | No | |
charge | form | decimal | No | |
credit | form | decimal | 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/{uuid}/Add/{reporting_term}/Submit HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
transaction_uuid: String,
uuid: String,
reporting_term: String,
description: String,
email_student: False,
registrations:
[
{
student_section_uuid: String,
description: String,
amount: 0,
charge: 0,
is_audit: False,
benefit_id: 0,
benefit_amount: 0,
second_benefit_id: 0,
second_benefit_amount: 0
}
],
additional_term_charges:
[
{
rate_id: 0,
description: String,
charge: 0,
credit: 0
}
],
authorizing_uuid: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }