Required role: | REGISUserRole |
POST | /Academic/ExternalDegree/AuthorizeDynamics/{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 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 ExternalDegreeAuthorizeDynamicsRequest:
uuid: Optional[str] = None
authorizing_uuid: Optional[str] = None
Python ExternalDegreeAuthorizeDynamicsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Academic/ExternalDegree/AuthorizeDynamics/{uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"uuid":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false},"gpa":0,"student_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}],"degrees":[{"id":0,"institution_id":0,"degree_name":"String","degree_override_name":"String","institution_name":"String","graduation_month":"String","start_year":0,"end_year":0,"is_only_in_d365":false}],"valid_degrees":[{"degree_code":"String","degree_name":"String","degree_type":"String"}]}