regis

<back to all web services

AddRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{reporting_term}/Submit
AddRegistrationsSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
transaction_uuidbodystringNo
uuidpathstringNo
reporting_termpathstringNo
descriptionbodystringNo
email_studentbodyboolNo
registrationsbodyList<AddRegistrationWithBenefitRequest>No
additional_term_chargesbodyList<AddRegistrationsAdditionalChargeSubmitRequest>No
authorizing_uuidbodystringNo
AddRegistrationWithBenefitRequest Parameters:
NameParameterData TypeRequiredDescription
student_section_uuidformstringNo
descriptionformstringNo
amountformdecimalNo
chargeformdecimalNo
is_auditformboolNo
benefit_idformint?No
benefit_amountformdecimal?No
second_benefit_idformint?No
second_benefit_amountformdecimal?No
AddRegistrationsAdditionalChargeSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
rate_idformintNo
descriptionformstringNo
chargeformdecimalNo
creditformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}