regis

PersonBaseValuesRequest

**Requires Authentication**
Required permission:	ReadPersonBaseValues

The following routes are available for this service:
POST	/person/baseValues

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 PersonExtendedResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    ubc_id: Optional[int] = None
    spouse_regent_id: Optional[int] = None
    uuid: Optional[str] = None
    regent_login: Optional[str] = None
    spouse_rwl: Optional[str] = None
    first_name: Optional[str] = None
    middle_name: Optional[str] = None
    last_name: Optional[str] = None
    preferred_name: Optional[str] = None
    birth_name: Optional[str] = None
    override_transcript_name: Optional[str] = None
    spouse_name: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    country: Optional[str] = None
    state: Optional[str] = None
    city: Optional[str] = None
    code: Optional[str] = None
    phone_home: Optional[str] = None
    phone_cell: Optional[str] = None
    phone_bus: Optional[str] = None
    email: Optional[str] = None
    prefix: Optional[str] = None
    dob: Optional[datetime.datetime] = None
    citizenship: Optional[str] = None
    citizenship_other: Optional[str] = None
    permanent_resident: Optional[str] = None
    denomination: Optional[str] = None
    occupation: Optional[str] = None
    ethnicity: Optional[str] = None
    gender: Optional[str] = None
    marital_status: Optional[str] = None
    deceased_date: Optional[datetime.datetime] = None
    is_donor: bool = False
    is_vendor: bool = False
    is_gp_customer: bool = False
    crm_student_status: Optional[str] = None
    crm_assigned: Optional[str] = None
    last_registered_term: Optional[str] = None
    is_regent_staff: bool = False
    regent_title: Optional[str] = None
    regent_department: Optional[str] = None
    regent_faculty_profile_url: Optional[str] = None
    regent_image_url: Optional[str] = None
    include_on_website: bool = False
    added_by: Optional[str] = None
    added_date: Optional[datetime.datetime] = None
    last_changed_by: Optional[str] = None
    last_changed_date: Optional[datetime.datetime] = None
    addr_last_changed_by: Optional[str] = None
    addr_last_changed_date: Optional[datetime.datetime] = None
    tax_number: Optional[str] = None
    regent_current_program: Optional[str] = None
    regent_degrees: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CountriesAndStatesResponse:
    country_code: Optional[str] = None
    country_name: Optional[str] = None
    states: Optional[Dict[str, str]] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Denomination:
    id: int = 0
    code: Optional[str] = None
    denomination_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Occupation:
    id: int = 0
    code: Optional[str] = None
    occupation_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Ethnicity:
    id: int = 0
    code: Optional[str] = None
    ethnicity_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PersonBaseValuesResponse:
    response_status: Optional[ResponseStatus] = None
    person: Optional[PersonExtendedResponse] = None
    countries_and_states: Optional[List[CountriesAndStatesResponse]] = None
    prefixes: Optional[List[PrefixResponse]] = None
    marital_statuses: Optional[Dict[str, str]] = None
    denominations: Optional[List[Denomination]] = None
    occupations: Optional[List[Occupation]] = None
    ethnicities: Optional[List[Ethnicity]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PersonBaseValuesRequest:
    pass

Python PersonBaseValuesRequest 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 /person/baseValues HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonBaseValuesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests" />

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

<PersonBaseValuesResponse 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>
  <countriesAndStates>
    <CountriesAndStatesResponse>
      <country_code>String</country_code>
      <country_name>String</country_name>
      <states xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </states>
    </CountriesAndStatesResponse>
  </countriesAndStates>
  <denominations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Denomination>
      <d2p1:code>String</d2p1:code>
      <d2p1:denomination_name>String</d2p1:denomination_name>
      <d2p1:id>0</d2p1:id>
    </d2p1:Denomination>
  </denominations>
  <ethnicities xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Ethnicity>
      <d2p1:code>String</d2p1:code>
      <d2p1:ethnicity_name>String</d2p1:ethnicity_name>
      <d2p1:id>0</d2p1:id>
    </d2p1:Ethnicity>
  </ethnicities>
  <maritalStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </maritalStatuses>
  <occupations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Occupation>
      <d2p1:code>String</d2p1:code>
      <d2p1:id>0</d2p1:id>
      <d2p1:occupation_name>String</d2p1:occupation_name>
    </d2p1:Occupation>
  </occupations>
  <person>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <addr_last_changed_by>String</addr_last_changed_by>
    <addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date>
    <birth_name>String</birth_name>
    <citizenship>String</citizenship>
    <citizenship_other>String</citizenship_other>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <crm_assigned>String</crm_assigned>
    <crm_student_status>String</crm_student_status>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <denomination>String</denomination>
    <dob>0001-01-01T00:00:00</dob>
    <email>String</email>
    <ethnicity>String</ethnicity>
    <first_name>String</first_name>
    <gender>String</gender>
    <include_on_website>false</include_on_website>
    <is_donor>false</is_donor>
    <is_gp_customer>false</is_gp_customer>
    <is_regent_staff>false</is_regent_staff>
    <is_vendor>false</is_vendor>
    <last_changed_by>String</last_changed_by>
    <last_changed_date>0001-01-01T00:00:00</last_changed_date>
    <last_name>String</last_name>
    <last_registered_term>String</last_registered_term>
    <marital_status>String</marital_status>
    <middle_name>String</middle_name>
    <occupation>String</occupation>
    <override_transcript_name>String</override_transcript_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>
    <prefix>String</prefix>
    <regent_current_program>String</regent_current_program>
    <regent_degrees>String</regent_degrees>
    <regent_department>String</regent_department>
    <regent_faculty_profile_url>String</regent_faculty_profile_url>
    <regent_id>0</regent_id>
    <regent_image_url>String</regent_image_url>
    <regent_login>String</regent_login>
    <regent_title>String</regent_title>
    <spouse_name>String</spouse_name>
    <spouse_regent_id>0</spouse_regent_id>
    <spouse_rwl>String</spouse_rwl>
    <state>String</state>
    <tax_number>String</tax_number>
    <ubc_id>0</ubc_id>
    <uuid>String</uuid>
  </person>
  <prefixes>
    <PrefixResponse>
      <prefix_code>String</prefix_code>
      <prefix_name>String</prefix_name>
    </PrefixResponse>
  </prefixes>
</PersonBaseValuesResponse>