| Required permission: | ReadExternalDegrees |
| POST | /Academic/{uuid}/ExternalDegrees |
|---|
export class PersonSimpleResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public ubc_id?: number;
public uuid: string;
public regent_login: string;
public first_name: string;
public preferred_name: string;
public middle_name: string;
public last_name: string;
public email: string;
public phone_home: string;
public phone_cell: string;
public phone_bus: string;
public addr1: string;
public addr2: string;
public city: string;
public state: string;
public country: string;
public code: string;
public citizenship: string;
public citizenship_other: string;
public permanent_resident: string;
public dob?: string;
public is_student: boolean;
public is_faculty: boolean;
public is_vendor: boolean;
public constructor(init?: Partial<PersonSimpleResponse>) { (Object as any).assign(this, init); }
}
export class StudentProgramSimpleResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public program_id: number;
public program_code: string;
public program_name: string;
public concentration_code: string;
public concentration_name: string;
public start_date?: string;
public end_date?: string;
public catalog: string;
public is_active: boolean;
public is_graduated: boolean;
public constructor(init?: Partial<StudentProgramSimpleResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreeResponse
{
public id?: number;
public institution_id?: number;
public degree_name: string;
public degree_override_name: string;
public institution_name: string;
public graduation_month: string;
public start_year?: number;
public end_year?: number;
public is_only_in_d365: boolean;
public constructor(init?: Partial<ExternalDegreeResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreesAdminResponse
{
public degree_code: string;
public degree_name: string;
public degree_type: string;
public constructor(init?: Partial<ExternalDegreesAdminResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreesResponse
{
public responseStatus: ResponseStatus;
public person: PersonSimpleResponse;
public gpa?: number;
public student_programs: StudentProgramSimpleResponse[];
public degrees: ExternalDegreeResponse[];
public valid_degrees: ExternalDegreesAdminResponse[];
public constructor(init?: Partial<ExternalDegreesResponse>) { (Object as any).assign(this, init); }
}
export class ExternalDegreesRequest
{
public uuid: string;
public constructor(init?: Partial<ExternalDegreesRequest>) { (Object as any).assign(this, init); }
}
TypeScript ExternalDegreesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>