regis

<back to all web services

DropRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{reporting_term}/Submit
DropRegistrationsSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
transaction_uuidbodystringNo
uuidpathstringNo
reporting_termpathstringNo
registrationsbodyList<DropRegistrationSubmitRequest>No
descriptionbodystringNo
drop_feebodydecimal?No
drop_descriptionbodystringNo
refund_student_feesbodyboolNo
authorizing_uuidbodystringNo
DropRegistrationSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
student_section_uuidformstringNo
tuition_refund_amountformdecimalNo
descriptionformstringNo
additional_rate_idformint?No
additional_rate_amountformdecimal?No
benefit_rate_idformint?No
second_benefit_rate_idformint?No
benefit_charge_amountformdecimal?No
second_benefit_charge_amountformdecimal?No

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/{uuid}/Drop/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DropRegistrationsSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <drop_description>String</drop_description>
  <drop_fee>0</drop_fee>
  <refund_student_fees>false</refund_student_fees>
  <registrations>
    <DropRegistrationSubmitRequest>
      <additional_rate_amount>0</additional_rate_amount>
      <additional_rate_id>0</additional_rate_id>
      <benefit_charge_amount>0</benefit_charge_amount>
      <benefit_rate_id>0</benefit_rate_id>
      <description>String</description>
      <second_benefit_charge_amount>0</second_benefit_charge_amount>
      <second_benefit_rate_id>0</second_benefit_rate_id>
      <student_section_uuid>String</student_section_uuid>
      <tuition_refund_amount>0</tuition_refund_amount>
    </DropRegistrationSubmitRequest>
  </registrations>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</DropRegistrationsSubmitRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>