regis

ExternalDegreesRequest

**Requires Authentication**
Required permission:	ReadExternalDegrees

The following routes are available for this service:
POST	/Academic/{uuid}/ExternalDegrees

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 StudentProgramSimpleResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    uuid: Optional[str] = None
    program_id: int = 0
    program_code: Optional[str] = None
    program_name: Optional[str] = None
    concentration_code: Optional[str] = None
    concentration_name: Optional[str] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    catalog: Optional[str] = None
    is_active: bool = False
    is_graduated: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalDegreeResponse:
    id: Optional[int] = None
    institution_id: Optional[int] = None
    degree_name: Optional[str] = None
    degree_override_name: Optional[str] = None
    institution_name: Optional[str] = None
    graduation_month: Optional[str] = None
    start_year: Optional[int] = None
    end_year: Optional[int] = None
    is_only_in_d365: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalDegreesAdminResponse:
    degree_code: Optional[str] = None
    degree_name: Optional[str] = None
    degree_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalDegreesResponse:
    response_status: Optional[ResponseStatus] = None
    person: Optional[PersonSimpleResponse] = None
    gpa: Optional[Decimal] = None
    student_programs: Optional[List[StudentProgramSimpleResponse]] = None
    degrees: Optional[List[ExternalDegreeResponse]] = None
    valid_degrees: Optional[List[ExternalDegreesAdminResponse]] = None


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

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

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

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

<ExternalDegreesResponse 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>
  <degrees>
    <ExternalDegreeResponse>
      <degree_name>String</degree_name>
      <degree_override_name>String</degree_override_name>
      <end_year>0</end_year>
      <graduation_month>String</graduation_month>
      <id>0</id>
      <institution_id>0</institution_id>
      <institution_name>String</institution_name>
      <is_only_in_d365>false</is_only_in_d365>
      <start_year>0</start_year>
    </ExternalDegreeResponse>
  </degrees>
  <gpa>0</gpa>
  <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>
    <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>
  </person>
  <student_programs>
    <StudentProgramSimpleResponse>
      <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>
      <catalog>String</catalog>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <is_active>false</is_active>
      <is_graduated>false</is_graduated>
      <program_code>String</program_code>
      <program_id>0</program_id>
      <program_name>String</program_name>
      <regent_id>0</regent_id>
      <start_date>0001-01-01T00:00:00</start_date>
      <uuid>String</uuid>
    </StudentProgramSimpleResponse>
  </student_programs>
  <valid_degrees>
    <ExternalDegreesAdminResponse>
      <degree_code>String</degree_code>
      <degree_name>String</degree_name>
      <degree_type>String</degree_type>
    </ExternalDegreesAdminResponse>
  </valid_degrees>
</ExternalDegreesResponse>