Required permission: | ReadRegistrationAvailability |
POST | /Registration/{reporting_term}/Available |
---|
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 RegistrationAvailableResponse:
response_status: Optional[ResponseStatus] = None
regent_id: Optional[int] = None
birthdate_exists: bool = False
birthdate_matches: bool = False
has_regent_login: bool = False
is_a_regis_person: bool = False
is_a_sugar_person: bool = False
term_is_available: bool = False
blocked_in_regis: bool = False
email_matches: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationAvailableRequest:
reporting_term: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
dob: Optional[datetime.datetime] = None
regent_id: Optional[int] = None
Python RegistrationAvailableRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/{reporting_term}/Available HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reporting_term: String,
first_name: String,
last_name: String,
email: String,
dob: 0001-01-01,
regent_id: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, regent_id: 0, birthdate_exists: False, birthdate_matches: False, has_regent_login: False, is_a_regis_person: False, is_a_sugar_person: False, term_is_available: False, blocked_in_regis: False, email_matches: False }