regis

<back to all web services

DropRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{reporting_term}
DropRegistrationsRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
reporting_termpathstringNo
registrationsbodyList<DropRegistrationResponse>No
override_drop_datebodyDateTime?No
authorizing_uuidbodystringNo
DropRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
student_section_uuidformstringNo
course_nameformstringNo
section_codeformstringNo
titleformstringNo
termformstringNo
amountformdecimalNo
is_auditformboolNo
is_grade_finalformboolNo
is_provisionalformboolNo
is_selected_to_dropformboolNo
suggested_refund_percentageformdecimalNo
suggested_refund_amountformdecimalNo
balance_amountformdecimalNo
charge_amountformdecimalNo
credit_amountformdecimalNo
descriptionformstringNo
additional_rate_descriptionformstringNo
additional_rate_idformint?No
additional_rate_amountformdecimal?No
additional_rate_suggested_refund_percentageformdecimal?No
additional_rate_suggested_refund_amountformdecimal?No
benefit_descriptionformstringNo
second_benefit_descriptionformstringNo
benefit_rate_idformint?No
benefit_amountformdecimal?No
second_benefit_amountformdecimal?No
second_benefit_rate_idformint?No
DropRegistrationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
transaction_uuidformstringNo
regent_idformintNo
uuidformstringNo
reporting_termformstringNo
suggested_drop_feeformdecimalNo
suggested_full_student_fee_refundformboolNo
messagesformList<string>No
registrationsformList<DropRegistrationResponse>No
invoiceItemBalancesformList<InvoiceItemBalanceResponse>No
InvoiceItemBalanceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
rate_idformintNo
rate_codeformstringNo
rate_descriptionformstringNo
balance_amountformdecimalNo
charge_amountformdecimalNo
credit_amountformdecimalNo

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/{uuid}/Drop/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","reporting_term":"String","registrations":[{"student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_grade_final":false,"is_provisional":false,"is_selected_to_drop":false,"suggested_refund_percentage":0,"suggested_refund_amount":0,"balance_amount":0,"charge_amount":0,"credit_amount":0,"description":"String","additional_rate_description":"String","additional_rate_id":0,"additional_rate_amount":0,"additional_rate_suggested_refund_percentage":0,"additional_rate_suggested_refund_amount":0,"benefit_description":"String","second_benefit_description":"String","benefit_rate_id":0,"benefit_amount":0,"second_benefit_amount":0,"second_benefit_rate_id":0}],"override_drop_date":"0001-01-01T00:00:00.0000000","authorizing_uuid":"String"}
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","suggested_drop_fee":0,"suggested_full_student_fee_refund":false,"messages":["String"],"registrations":[{"student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_grade_final":false,"is_provisional":false,"is_selected_to_drop":false,"suggested_refund_percentage":0,"suggested_refund_amount":0,"balance_amount":0,"charge_amount":0,"credit_amount":0,"description":"String","additional_rate_description":"String","additional_rate_id":0,"additional_rate_amount":0,"additional_rate_suggested_refund_percentage":0,"additional_rate_suggested_refund_amount":0,"benefit_description":"String","second_benefit_description":"String","benefit_rate_id":0,"benefit_amount":0,"second_benefit_amount":0,"second_benefit_rate_id":0}],"invoiceItemBalances":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"rate_id":0,"rate_code":"String","rate_description":"String","balance_amount":0,"charge_amount":0,"credit_amount":0}]}