regis

RegistrationAvailableRequest

**Requires Authentication**
Required permission:	ReadRegistrationAvailability

The following routes are available for this service:
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 .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/{reporting_term}/Available HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RegistrationAvailableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <first_name>String</first_name>
  <last_name>String</last_name>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
</RegistrationAvailableRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationAvailableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <birthdate_exists>false</birthdate_exists>
  <birthdate_matches>false</birthdate_matches>
  <blocked_in_regis>false</blocked_in_regis>
  <email_matches>false</email_matches>
  <has_regent_login>false</has_regent_login>
  <is_a_regis_person>false</is_a_regis_person>
  <is_a_sugar_person>false</is_a_sugar_person>
  <regent_id>0</regent_id>
  <term_is_available>false</term_is_available>
</RegistrationAvailableResponse>