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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DropRegistrationSubmitRequest:
    student_section_uuid: Optional[str] = None
    tuition_refund_amount: Decimal = decimal.Decimal(0)
    description: Optional[str] = None
    additional_rate_id: Optional[int] = None
    additional_rate_amount: Optional[Decimal] = None
    benefit_rate_id: Optional[int] = None
    second_benefit_rate_id: Optional[int] = None
    benefit_charge_amount: Optional[Decimal] = None
    second_benefit_charge_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DropRegistrationsSubmitRequest:
    transaction_uuid: Optional[str] = None
    uuid: Optional[str] = None
    reporting_term: Optional[str] = None
    registrations: Optional[List[DropRegistrationSubmitRequest]] = None
    description: Optional[str] = None
    drop_fee: Optional[Decimal] = None
    drop_description: Optional[str] = None
    refund_student_fees: bool = False
    authorizing_uuid: Optional[str] = None

Python DropRegistrationsSubmitRequest DTOs

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}/Drop/{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","registrations":[{"student_section_uuid":"String","tuition_refund_amount":0,"description":"String","additional_rate_id":0,"additional_rate_amount":0,"benefit_rate_id":0,"second_benefit_rate_id":0,"benefit_charge_amount":0,"second_benefit_charge_amount":0}],"description":"String","drop_fee":0,"drop_description":"String","refund_student_fees":false,"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"}}