regis

<back to all web services

CRMApplicationUpsertMultipleRequest

Requires Authentication
Required permission:UpdateApplication
The following routes are available for this service:
POST/DynamicsCRM/Application/Upsert/Multiple

export class CRMApplicationLanguageTestCreateRequest
{
    public type: string;
    public test_date?: string;
    public score?: number;
    public applicant_defined: boolean;
    public status: string;

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

export class CRMApplicationRefereeCreateRequest
{
    public import_id: number;
    public first_name: string;
    public last_name: string;
    public job_title: string;
    public email: string;
    public phone: string;
    public type: string;
    public full_name: string;
    public position: string;
    public organization: string;
    public email_from_referee: string;
    public relationship: string;
    public relationship_details: string;
    public personal_evaluation: string;
    public ability_question_1?: number;
    public ability_question_2?: number;
    public ability_question_3?: number;
    public ability_question_4?: number;
    public ability_question_5?: number;
    public ability_question_6?: number;
    public ability_question_7?: number;
    public ability_question_8?: number;
    public ability_question_9?: number;
    public ability_question_10?: number;
    public qualify_assessment: string;
    public recommendation: string;
    public recommendation_details: string;
    public is_regent_alum: boolean;
    public is_complete: boolean;
    public email_sent?: string;
    public submitted_date?: string;

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

export class CRMApplicationRequirementCreateRequest
{
    public status: string;
    public requirement_name: string;
    public requested_date?: string;
    public received_date?: string;

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

export class CRMEducationUpsertRequest
{
    public regent_id: number;
    public import_id?: number;
    public institution_regent_id?: number;
    public application_guid: string;
    public degree_status: string;
    public degree_type: string;
    public unofficial_institution_name: string;
    public unofficial_degree_name: string;
    public degree_name: string;
    public degree_code: string;
    public description: string;
    public major: string;
    public second_major: string;
    public cumulative_gpa?: number;
    public is_final: boolean;
    public is_regis_external_degree: boolean;
    public start_year?: number;
    public end_year?: number;
    public month_graduated?: number;
    public year_graduated?: number;
    public added_date?: string;

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

export class CRMApplicationCreateRequest
{
    public regent_id: number;
    public import_id: number;
    public application_name: string;
    public academic_program: string;
    public start_term: string;
    public location: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public former_name: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public spouse_name: string;
    public children: string;
    public native_english_speaker: boolean;
    public native_language: string;
    public birth_place: string;
    public residency_status: string;
    public language_test_exemption_request_date?: string;
    public language_test_exemption_decision_date?: string;
    public language_test_exemption_decision: string;
    public language_test_comment: string;
    public language_tests: CRMApplicationLanguageTestCreateRequest[];
    public references: CRMApplicationRefereeCreateRequest[];
    public requirements: CRMApplicationRequirementCreateRequest[];
    public education: CRMEducationUpsertRequest[];
    public church_attended: string;
    public pastor_first_name: string;
    public pastor_last_name: string;
    public has_impairment: boolean;
    public impairment_description: string;
    public apply_for_financial_aid: boolean;
    public financial_description: string;
    public employment_years?: number;
    public employment_description: string;
    public church_volunteer_years?: number;
    public church_volunteer_description: string;
    public other_volunteer_years?: number;
    public other_volunteer_description: string;
    public accomplishments_description: string;
    public what_other_graduate_schools_are_you_apply: string;
    public what_else_interests_you_about_regent: string;
    public heard_about_regent_from_book: string;
    public heard_about_regent_from_event: string;
    public heard_about_regent_from_organization: string;
    public heard_about_regent_from_person: string;
    public heard_about_regent_from_website_pub: string;
    public what_interests_you_about_regent: string[];
    public what_else_brought_you_to_regent: string;
    public start_via_distance_ed: boolean;
    public transfer_credits: boolean;
    public applicant_comments: string;
    public cumulative_undergraduate_gpa?: number;
    public cumulative_graduate_gpa?: number;
    public conditional_admission: boolean;
    public conditional_admission_reason: string[];
    public admission_notes: string;
    public admission_decision_notes: string;
    public withdrawn_reason: string;
    public submitted?: string;
    public paid?: string;
    public reviewed?: string;
    public completed?: string;
    public rejected?: string;
    public admitted?: string;
    public postponed?: string;
    public withdrawn?: string;
    public confirmed?: string;
    public read_theological_position?: string;
    public current_status: string;
    public image_base64: string;
    public promo_code: string;
    public added_date: string;
    public last_contacted_date?: string;
    public owning_username: string;

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

export class CRMApplicationUpsertMultipleRequest
{
    public applications: CRMApplicationCreateRequest[];

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

TypeScript CRMApplicationUpsertMultipleRequest 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 /DynamicsCRM/Application/Upsert/Multiple HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	applications: 
	[
		{
			regent_id: 0,
			import_id: 0,
			application_name: String,
			academic_program: String,
			start_term: String,
			location: String,
			addr1: String,
			addr2: String,
			city: String,
			state: String,
			country: String,
			code: String,
			former_name: String,
			citizenship: String,
			citizenship_other: String,
			permanent_resident: String,
			spouse_name: String,
			children: String,
			native_english_speaker: False,
			native_language: String,
			birth_place: String,
			residency_status: String,
			language_test_exemption_request_date: 0001-01-01,
			language_test_exemption_decision_date: 0001-01-01,
			language_test_exemption_decision: String,
			language_test_comment: String,
			language_tests: 
			[
				{
					type: String,
					test_date: 0001-01-01,
					score: 0,
					applicant_defined: False,
					status: String
				}
			],
			references: 
			[
				{
					import_id: 0,
					first_name: String,
					last_name: String,
					job_title: String,
					email: String,
					phone: String,
					type: String,
					full_name: String,
					position: String,
					organization: String,
					email_from_referee: String,
					relationship: String,
					relationship_details: String,
					personal_evaluation: String,
					ability_question_1: 0,
					ability_question_2: 0,
					ability_question_3: 0,
					ability_question_4: 0,
					ability_question_5: 0,
					ability_question_6: 0,
					ability_question_7: 0,
					ability_question_8: 0,
					ability_question_9: 0,
					ability_question_10: 0,
					qualify_assessment: String,
					recommendation: String,
					recommendation_details: String,
					is_regent_alum: False,
					is_complete: False,
					email_sent: 0001-01-01,
					submitted_date: 0001-01-01
				}
			],
			requirements: 
			[
				{
					status: String,
					requirement_name: String,
					requested_date: 0001-01-01,
					received_date: 0001-01-01
				}
			],
			education: 
			[
				{
					regent_id: 0,
					import_id: 0,
					institution_regent_id: 0,
					application_guid: String,
					degree_status: String,
					degree_type: String,
					unofficial_institution_name: String,
					unofficial_degree_name: String,
					degree_name: String,
					degree_code: String,
					description: String,
					major: String,
					second_major: String,
					cumulative_gpa: 0,
					is_final: False,
					is_regis_external_degree: False,
					start_year: 0,
					end_year: 0,
					month_graduated: 0,
					year_graduated: 0,
					added_date: 0001-01-01
				}
			],
			church_attended: String,
			pastor_first_name: String,
			pastor_last_name: String,
			has_impairment: False,
			impairment_description: String,
			apply_for_financial_aid: False,
			financial_description: String,
			employment_years: 0,
			employment_description: String,
			church_volunteer_years: 0,
			church_volunteer_description: String,
			other_volunteer_years: 0,
			other_volunteer_description: String,
			accomplishments_description: String,
			what_other_graduate_schools_are_you_apply: String,
			what_else_interests_you_about_regent: String,
			heard_about_regent_from_book: String,
			heard_about_regent_from_event: String,
			heard_about_regent_from_organization: String,
			heard_about_regent_from_person: String,
			heard_about_regent_from_website_pub: String,
			what_interests_you_about_regent: 
			[
				String
			],
			what_else_brought_you_to_regent: String,
			start_via_distance_ed: False,
			transfer_credits: False,
			applicant_comments: String,
			cumulative_undergraduate_gpa: 0,
			cumulative_graduate_gpa: 0,
			conditional_admission: False,
			conditional_admission_reason: 
			[
				String
			],
			admission_notes: String,
			admission_decision_notes: String,
			withdrawn_reason: String,
			submitted: 0001-01-01,
			paid: 0001-01-01,
			reviewed: 0001-01-01,
			completed: 0001-01-01,
			rejected: 0001-01-01,
			admitted: 0001-01-01,
			postponed: 0001-01-01,
			withdrawn: 0001-01-01,
			confirmed: 0001-01-01,
			read_theological_position: 0001-01-01,
			current_status: String,
			image_base64: String,
			promo_code: String,
			added_date: 0001-01-01,
			last_contacted_date: 0001-01-01,
			owning_username: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}