regis

<back to all web services

AddProvisionalRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/AddProvisional/{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 AddRegistrationWithBenefitRequest:
    student_section_uuid: Optional[str] = None
    description: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    charge: Decimal = decimal.Decimal(0)
    is_audit: bool = False
    benefit_id: Optional[int] = None
    benefit_amount: Optional[Decimal] = None
    second_benefit_id: Optional[int] = None
    second_benefit_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddProvisionalRegistrationsSubmitRequest:
    transaction_uuid: Optional[str] = None
    uuid: Optional[str] = None
    reporting_term: Optional[str] = None
    email_student: bool = False
    registrations: Optional[List[AddRegistrationWithBenefitRequest]] = None
    authorizing_uuid: Optional[str] = None

Python AddProvisionalRegistrationsSubmitRequest 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}/AddProvisional/{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","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}],"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"}}