Required permission: | ReadRegistrationAvailability |
POST | /registration/recent |
---|
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 StudentAcademicCredentialSimpleResponse
{
public responseStatus: ResponseStatus;
public course_uuid: string;
public course_name: string;
public section_code: string;
public section_id?: number;
public term: string;
public reporting_term: string;
public title: string;
public amount?: number;
public is_audit: boolean;
public is_pass_fail: boolean;
public is_graded: boolean;
public constructor(init?: Partial<StudentAcademicCredentialSimpleResponse>) { (Object as any).assign(this, init); }
}
export class StudentAcademicCredentialByReportingTermSimpleResponse
{
public responseStatus: ResponseStatus;
public reportingTerm: string;
public onlineCreditsAttempted: number;
public onlineAuditsAttempted: number;
public studentAcademicCredentialSimpleResponse: StudentAcademicCredentialSimpleResponse[];
public constructor(init?: Partial<StudentAcademicCredentialByReportingTermSimpleResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationDocumentResponse
{
public uuid: string;
public regent_id: number;
public first_name: string;
public last_name: string;
public gender: string;
public email: string;
public program: string;
public concentration: string;
public section_uuid: string;
public course_name: string;
public course_title: string;
public reporting_term: string;
public document_code: string;
public document_json: string;
public document_name: string;
public document_description: string;
public added_date?: string;
public changed_date?: string;
public constructor(init?: Partial<RegistrationDocumentResponse>) { (Object as any).assign(this, init); }
}
export class ProvisionalRegistrationResponse
{
public uuid: string;
public regent_id?: number;
public student_name: string;
public email: string;
public section_uuid: string;
public student_section_uuid: string;
public course_name: string;
public section_code: string;
public title: string;
public term: string;
public amount: number;
public is_audit: boolean;
public is_waitlist: boolean;
public is_missing_requisites: boolean;
public is_other_restriction: boolean;
public documents: RegistrationDocumentResponse[];
public requested_date: string;
public constructor(init?: Partial<ProvisionalRegistrationResponse>) { (Object as any).assign(this, init); }
}
export class ProvisionalRegistrationsForStudentResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public provisional_registrations: ProvisionalRegistrationResponse[];
public constructor(init?: Partial<ProvisionalRegistrationsForStudentResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationSummaryResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public is_missing_tax_number: boolean;
public person: PersonSimpleResponse;
public registrations: StudentAcademicCredentialByReportingTermSimpleResponse[];
public provisional_registrations: ProvisionalRegistrationsForStudentResponse;
public constructor(init?: Partial<RegistrationSummaryResponse>) { (Object as any).assign(this, init); }
}
export class RecentRegistrationRequest
{
public uuid: string;
public from_this_term: string;
public constructor(init?: Partial<RecentRegistrationRequest>) { (Object as any).assign(this, init); }
}
TypeScript RecentRegistrationRequest 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 /registration/recent HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<RecentRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<from_this_term>String</from_this_term>
<uuid>String</uuid>
</RecentRegistrationRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <RegistrationSummaryResponse 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> <is_missing_tax_number>false</is_missing_tax_number> <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> <provisional_registrations> <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> <provisional_registrations> <ProvisionalRegistrationResponse> <amount>0</amount> <course_name>String</course_name> <documents> <RegistrationDocumentResponse> <added_date>0001-01-01T00:00:00</added_date> <changed_date>0001-01-01T00:00:00</changed_date> <concentration>String</concentration> <course_name>String</course_name> <course_title>String</course_title> <document_code>String</document_code> <document_description>String</document_description> <document_json>String</document_json> <document_name>String</document_name> <email>String</email> <first_name>String</first_name> <gender>String</gender> <last_name>String</last_name> <program>String</program> <regent_id>0</regent_id> <reporting_term>String</reporting_term> <section_uuid>String</section_uuid> <uuid>String</uuid> </RegistrationDocumentResponse> </documents> <email>String</email> <is_audit>false</is_audit> <is_missing_requisites>false</is_missing_requisites> <is_other_restriction>false</is_other_restriction> <is_waitlist>false</is_waitlist> <regent_id>0</regent_id> <requested_date>0001-01-01T00:00:00</requested_date> <section_code>String</section_code> <section_uuid>String</section_uuid> <student_name>String</student_name> <student_section_uuid>String</student_section_uuid> <term>String</term> <title>String</title> <uuid>String</uuid> </ProvisionalRegistrationResponse> </provisional_registrations> <regent_id>0</regent_id> <uuid>String</uuid> </provisional_registrations> <regent_id>0</regent_id> <registrations> <StudentAcademicCredentialByReportingTermSimpleResponse> <OnlineAuditsAttempted>0</OnlineAuditsAttempted> <OnlineCreditsAttempted>0</OnlineCreditsAttempted> <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> <reportingTerm>String</reportingTerm> <studentAcademicCredentialSimpleResponse> <StudentAcademicCredentialSimpleResponse> <ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types"> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:Message>String</d6p1:Message> <d6p1:StackTrace>String</d6p1:StackTrace> <d6p1:Errors> <d6p1:ResponseError> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:FieldName>String</d6p1:FieldName> <d6p1:Message>String</d6p1:Message> <d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d9p1:KeyValueOfstringstring> <d9p1:Key>String</d9p1:Key> <d9p1:Value>String</d9p1:Value> </d9p1:KeyValueOfstringstring> </d6p1:Meta> </d6p1:ResponseError> </d6p1:Errors> <d6p1: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> </d6p1:Meta> </ResponseStatus> <amount>0</amount> <course_name>String</course_name> <course_uuid>String</course_uuid> <is_audit>false</is_audit> <is_graded>false</is_graded> <is_pass_fail>false</is_pass_fail> <reporting_term>String</reporting_term> <section_code>String</section_code> <section_id>0</section_id> <term>String</term> <title>String</title> </StudentAcademicCredentialSimpleResponse> </studentAcademicCredentialSimpleResponse> </StudentAcademicCredentialByReportingTermSimpleResponse> </registrations> <uuid>String</uuid> </RegistrationSummaryResponse>