regis

<back to all web services

UnauthenticatedRegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid}

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 RegistrationInProgressSummaryResponse
{
    public responseStatus: ResponseStatus;
    public transaction_uuid: string;
    public regent_id: number;
    public uuid: string;
    public reporting_term: string;
    public numberOfStudentSections: number;
    public amountOwing: number;
    public mustPayBeforeRegistering: boolean;
    public requiredDocuments: RegistrationDocumentResponse[];
    public completedDocuments: RegistrationDocumentResponse[];
    public isLate: boolean;

    public constructor(init?: Partial<RegistrationInProgressSummaryResponse>) { (Object as any).assign(this, init); }
}

export class UnauthenticatedRegistrationInProgressSummaryRequest
{
    public uuid: string;
    public transaction_uuid: string;
    public reporting_term: string;
    public audio_only: boolean;

    public constructor(init?: Partial<UnauthenticatedRegistrationInProgressSummaryRequest>) { (Object as any).assign(this, init); }
}

TypeScript UnauthenticatedRegistrationInProgressSummaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	transaction_uuid: String,
	reporting_term: String,
	audio_only: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	transaction_uuid: String,
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	numberOfStudentSections: 0,
	amountOwing: 0,
	mustPayBeforeRegistering: False,
	requiredDocuments: 
	[
		{
			uuid: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			gender: String,
			email: String,
			program: String,
			concentration: String,
			section_uuid: String,
			course_name: String,
			course_title: String,
			reporting_term: String,
			document_code: String,
			document_json: String,
			document_name: String,
			document_description: String,
			added_date: 0001-01-01,
			changed_date: 0001-01-01
		}
	],
	completedDocuments: 
	[
		{
			uuid: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			gender: String,
			email: String,
			program: String,
			concentration: String,
			section_uuid: String,
			course_name: String,
			course_title: String,
			reporting_term: String,
			document_code: String,
			document_json: String,
			document_name: String,
			document_description: String,
			added_date: 0001-01-01,
			changed_date: 0001-01-01
		}
	],
	isLate: False
}