Required role: | REGISUserRole |
POST | /Registration/InProgress/{uuid}/Term/{reporting_term}/Review/{transaction_uuid} |
---|
export class InvoiceResponse
{
public responseStatus: ResponseStatus;
public invoiceUUID: string;
public regent_id: number;
public uuid: string;
public reporting_term: string;
public total_charges?: number;
public total_credits?: number;
public current_status: string;
public timestamp: string;
public constructor(init?: Partial<InvoiceResponse>) { (Object as any).assign(this, init); }
}
export class InvoiceItemResponse
{
public responseStatus: ResponseStatus;
public invoiceItemUUID: string;
public rate_id: number;
public rate_code: string;
public rate_description: string;
public charge?: number;
public credit?: number;
public constructor(init?: Partial<InvoiceItemResponse>) { (Object as any).assign(this, init); }
}
export class InstructorResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public regent_login: string;
public preferred_name: string;
public first_name: string;
public last_name: string;
public full_name: string;
public email: string;
public image_base64: string;
public constructor(init?: Partial<InstructorResponse>) { (Object as any).assign(this, init); }
}
export class DocumentResponse
{
public code: string;
public document_name: string;
public document_description: string;
public constructor(init?: Partial<DocumentResponse>) { (Object as any).assign(this, init); }
}
export class SectionResponse
{
public responseStatus: ResponseStatus;
public secUUID: string;
public course_name: string;
public section_code: string;
public course_title: string;
public course_short_title: string;
public course_description: string;
public crosslist_description: string;
public crosslist_course_name: string;
public location_long_name: string;
public room: string;
public instructors: InstructorResponse[];
public required_documents: DocumentResponse[];
public start_date?: string;
public end_date?: string;
public first_meeting_date?: string;
public last_meeting_date?: string;
public meeting_days: string;
public start_times: string[];
public end_times: string[];
public is_online_only: boolean;
public is_weekend: boolean;
public is_weekday: boolean;
public is_evening: boolean;
public is_waitlist: boolean;
public has_special_requirements: boolean;
public special_requirements: string;
public is_unlisted: boolean;
public credit_amounts: number[];
public audit_amounts: number[];
public audits_short_name: string;
public audits_long_name: string;
public credits_short_name: string;
public credits_long_name: string;
public distance_ed_materials: string;
public prerequisites: string;
public corequisites: string;
public capacity?: number;
public flat_fee_amount?: number;
public additional_fee_amount?: number;
public registered_students: number;
public three_credit_plus: number;
public two_credit: number;
public one_credit: number;
public three_audit_plus: number;
public two_audit: number;
public one_audit: number;
public crosslist_registered_students: number;
public grades_received: number;
public crosslist_grades_received: number;
public registration_start_date?: string;
public registration_end_date?: string;
public add_start_date?: string;
public add_end_date?: string;
public drop_start_date?: string;
public drop_end_date?: string;
public grading_end_date?: string;
public term: string;
public reporting_term: string;
public reporting_year: number;
public current_status: string;
public added_by: string;
public added_date?: string;
public changed_by: string;
public changed_date?: string;
public timestamp: string;
public constructor(init?: Partial<SectionResponse>) { (Object as any).assign(this, init); }
}
export class StudentSectionResponse extends SectionResponse
{
public studentSectionUUID: string;
public registered_amount: number;
public is_provisional: boolean;
public is_audit: boolean;
public constructor(init?: Partial<StudentSectionResponse>) { super(init); (Object as any).assign(this, init); }
}
export class StudentSectionInvoiceItemResponse extends InvoiceItemResponse
{
public studentSection: StudentSectionResponse;
public constructor(init?: Partial<StudentSectionInvoiceItemResponse>) { super(init); (Object as any).assign(this, init); }
}
export class StudentSectionInvoiceResponse extends InvoiceResponse
{
public transaction_uuid: string;
public studentSectionInvoiceItems: StudentSectionInvoiceItemResponse[];
public otherInvoiceItems: InvoiceItemResponse[];
public optedInInvoiceItems: InvoiceItemResponse[];
public optionalInvoiceItems: InvoiceItemResponse[];
public appliedForSpousalAuditBenefit: boolean;
public appliedForSpousalCreditBenefit: boolean;
public appliedForDEReentryBenefit: boolean;
public dropRefundRate?: number;
public constructor(init?: Partial<StudentSectionInvoiceResponse>) { super(init); (Object as any).assign(this, init); }
}
export class RegistrationInProgressReviewRequest
{
public transaction_uuid: string;
public uuid: string;
public reporting_term: string;
public rates_opted_in: number[];
public authorizing_uuid: string;
public appliedForDEReentryBenefit: boolean;
public appliedForSpousalAuditBenefit: boolean;
public appliedForSpousalCreditBenefit: boolean;
public constructor(init?: Partial<RegistrationInProgressReviewRequest>) { (Object as any).assign(this, init); }
}
TypeScript RegistrationInProgressReviewRequest 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/InProgress/{uuid}/Term/{reporting_term}/Review/{transaction_uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<RegistrationInProgressReviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<appliedForDEReentryBenefit>false</appliedForDEReentryBenefit>
<appliedForSpousalAuditBenefit>false</appliedForSpousalAuditBenefit>
<appliedForSpousalCreditBenefit>false</appliedForSpousalCreditBenefit>
<authorizing_uuid>String</authorizing_uuid>
<rates_opted_in xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</rates_opted_in>
<reporting_term>String</reporting_term>
<transaction_uuid>String</transaction_uuid>
<uuid>String</uuid>
</RegistrationInProgressReviewRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <StudentSectionInvoiceResponse 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> <current_status>String</current_status> <invoiceUUID>String</invoiceUUID> <regent_id>0</regent_id> <reporting_term>String</reporting_term> <timestamp>0001-01-01T00:00:00</timestamp> <total_charges>0</total_charges> <total_credits>0</total_credits> <uuid>String</uuid> <appliedForDEReentryBenefit>false</appliedForDEReentryBenefit> <appliedForSpousalAuditBenefit>false</appliedForSpousalAuditBenefit> <appliedForSpousalCreditBenefit>false</appliedForSpousalCreditBenefit> <dropRefundRate>0</dropRefundRate> <optedInInvoiceItems> <InvoiceItemResponse> <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> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </InvoiceItemResponse> </optedInInvoiceItems> <optionalInvoiceItems> <InvoiceItemResponse> <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> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </InvoiceItemResponse> </optionalInvoiceItems> <otherInvoiceItems> <InvoiceItemResponse> <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> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </InvoiceItemResponse> </otherInvoiceItems> <studentSectionInvoiceItems> <StudentSectionInvoiceItemResponse> <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> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> <studentSection> <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types"> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:Message>String</d5p1:Message> <d5p1:StackTrace>String</d5p1:StackTrace> <d5p1:Errors> <d5p1:ResponseError> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:FieldName>String</d5p1:FieldName> <d5p1:Message>String</d5p1:Message> <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d5p1:Meta> </d5p1:ResponseError> </d5p1:Errors> <d5p1: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> </d5p1:Meta> </ResponseStatus> <add_end_date>0001-01-01T00:00:00</add_end_date> <add_start_date>0001-01-01T00:00:00</add_start_date> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <additional_fee_amount>0</additional_fee_amount> <audit_amounts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:decimal>0</d5p1:decimal> </audit_amounts> <audits_long_name>String</audits_long_name> <audits_short_name>String</audits_short_name> <capacity>0</capacity> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <corequisites>String</corequisites> <course_description>String</course_description> <course_name>String</course_name> <course_short_title>String</course_short_title> <course_title>String</course_title> <credit_amounts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:decimal>0</d5p1:decimal> </credit_amounts> <credits_long_name>String</credits_long_name> <credits_short_name>String</credits_short_name> <crosslist_course_name>String</crosslist_course_name> <crosslist_description>String</crosslist_description> <crosslist_grades_received>0</crosslist_grades_received> <crosslist_registered_students>0</crosslist_registered_students> <current_status>String</current_status> <distance_ed_materials>String</distance_ed_materials> <drop_end_date>0001-01-01T00:00:00</drop_end_date> <drop_start_date>0001-01-01T00:00:00</drop_start_date> <end_date>0001-01-01T00:00:00</end_date> <end_times xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </end_times> <first_meeting_date>0001-01-01T00:00:00</first_meeting_date> <flat_fee_amount>0</flat_fee_amount> <grades_received>0</grades_received> <grading_end_date>0001-01-01T00:00:00</grading_end_date> <has_special_requirements>false</has_special_requirements> <instructors> <InstructorResponse> <ResponseStatus xmlns:d7p1="http://schemas.servicestack.net/types"> <d7p1:ErrorCode>String</d7p1:ErrorCode> <d7p1:Message>String</d7p1:Message> <d7p1:StackTrace>String</d7p1:StackTrace> <d7p1:Errors> <d7p1:ResponseError> <d7p1:ErrorCode>String</d7p1:ErrorCode> <d7p1:FieldName>String</d7p1:FieldName> <d7p1:Message>String</d7p1:Message> <d7p1:Meta xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d10p1:KeyValueOfstringstring> <d10p1:Key>String</d10p1:Key> <d10p1:Value>String</d10p1:Value> </d10p1:KeyValueOfstringstring> </d7p1:Meta> </d7p1:ResponseError> </d7p1:Errors> <d7p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d7p1:Meta> </ResponseStatus> <email>String</email> <first_name>String</first_name> <full_name>String</full_name> <image_base64>String</image_base64> <last_name>String</last_name> <preferred_name>String</preferred_name> <regent_id>0</regent_id> <regent_login>String</regent_login> </InstructorResponse> </instructors> <is_evening>false</is_evening> <is_online_only>false</is_online_only> <is_unlisted>false</is_unlisted> <is_waitlist>false</is_waitlist> <is_weekday>false</is_weekday> <is_weekend>false</is_weekend> <last_meeting_date>0001-01-01T00:00:00</last_meeting_date> <location_long_name>String</location_long_name> <meeting_days>String</meeting_days> <one_audit>0</one_audit> <one_credit>0</one_credit> <prerequisites>String</prerequisites> <registered_students>0</registered_students> <registration_end_date>0001-01-01T00:00:00</registration_end_date> <registration_start_date>0001-01-01T00:00:00</registration_start_date> <reporting_term>String</reporting_term> <reporting_year>0</reporting_year> <required_documents> <DocumentResponse> <code>String</code> <document_description>String</document_description> <document_name>String</document_name> </DocumentResponse> </required_documents> <room>String</room> <secUUID>String</secUUID> <section_code>String</section_code> <special_requirements>String</special_requirements> <start_date>0001-01-01T00:00:00</start_date> <start_times xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </start_times> <term>String</term> <three_audit_plus>0</three_audit_plus> <three_credit_plus>0</three_credit_plus> <timestamp>0001-01-01T00:00:00</timestamp> <two_audit>0</two_audit> <two_credit>0</two_credit> <is_audit>false</is_audit> <is_provisional>false</is_provisional> <registered_amount>0</registered_amount> <studentSectionUUID>String</studentSectionUUID> </studentSection> </StudentSectionInvoiceItemResponse> </studentSectionInvoiceItems> <transaction_uuid>String</transaction_uuid> </StudentSectionInvoiceResponse>