regis

<back to all web services

SectionGuestRequest

Requires Authentication
Required permission:ReadSectionGuest
The following routes are available for this service:
POST/Sections/Guest/{uuid}
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 PersonSimpleResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    ubc_id: Optional[int] = None
    uuid: Optional[str] = None
    regent_login: Optional[str] = None
    first_name: Optional[str] = None
    preferred_name: Optional[str] = None
    middle_name: Optional[str] = None
    last_name: Optional[str] = None
    email: Optional[str] = None
    phone_home: Optional[str] = None
    phone_cell: Optional[str] = None
    phone_bus: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    citizenship: Optional[str] = None
    citizenship_other: Optional[str] = None
    permanent_resident: Optional[str] = None
    dob: Optional[datetime.datetime] = None
    is_student: bool = False
    is_faculty: bool = False
    is_vendor: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionGuestResponse:
    uuid: Optional[str] = None
    course_name: Optional[str] = None
    title: Optional[str] = None
    term: Optional[str] = None
    reporting_term: Optional[str] = None
    guest_list: Optional[List[PersonSimpleResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionGuestRequest:
    uuid: Optional[str] = None

Python SectionGuestRequest 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 /Sections/Guest/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SectionGuestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</SectionGuestRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SectionGuestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <course_name>String</course_name>
  <guest_list>
    <PersonSimpleResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <addr1>String</addr1>
      <addr2>String</addr2>
      <citizenship>String</citizenship>
      <citizenship_other>String</citizenship_other>
      <city>String</city>
      <code>String</code>
      <country>String</country>
      <dob>0001-01-01T00:00:00</dob>
      <email>String</email>
      <first_name>String</first_name>
      <is_faculty>false</is_faculty>
      <is_student>false</is_student>
      <is_vendor>false</is_vendor>
      <last_name>String</last_name>
      <middle_name>String</middle_name>
      <permanent_resident>String</permanent_resident>
      <phone_bus>String</phone_bus>
      <phone_cell>String</phone_cell>
      <phone_home>String</phone_home>
      <preferred_name>String</preferred_name>
      <regent_id>0</regent_id>
      <regent_login>String</regent_login>
      <state>String</state>
      <ubc_id>0</ubc_id>
      <uuid>String</uuid>
    </PersonSimpleResponse>
  </guest_list>
  <reporting_term>String</reporting_term>
  <term>String</term>
  <title>String</title>
  <uuid>String</uuid>
</SectionGuestResponse>