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
"use strict";
export class CRMApplicationLanguageTestCreateRequest {
    /** @param {{type?:string,test_date?:string,score?:number,applicant_defined?:boolean,status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    type;
    /** @type {?string} */
    test_date;
    /** @type {?number} */
    score;
    /** @type {boolean} */
    applicant_defined;
    /** @type {string} */
    status;
}
export class CRMApplicationRefereeCreateRequest {
    /** @param {{import_id?:number,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?:number,ability_question_2?:number,ability_question_3?:number,ability_question_4?:number,ability_question_5?:number,ability_question_6?:number,ability_question_7?:number,ability_question_8?:number,ability_question_9?:number,ability_question_10?:number,qualify_assessment?:string,recommendation?:string,recommendation_details?:string,is_regent_alum?:boolean,is_complete?:boolean,email_sent?:string,submitted_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    import_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    job_title;
    /** @type {string} */
    email;
    /** @type {string} */
    phone;
    /** @type {string} */
    type;
    /** @type {string} */
    full_name;
    /** @type {string} */
    position;
    /** @type {string} */
    organization;
    /** @type {string} */
    email_from_referee;
    /** @type {string} */
    relationship;
    /** @type {string} */
    relationship_details;
    /** @type {string} */
    personal_evaluation;
    /** @type {?number} */
    ability_question_1;
    /** @type {?number} */
    ability_question_2;
    /** @type {?number} */
    ability_question_3;
    /** @type {?number} */
    ability_question_4;
    /** @type {?number} */
    ability_question_5;
    /** @type {?number} */
    ability_question_6;
    /** @type {?number} */
    ability_question_7;
    /** @type {?number} */
    ability_question_8;
    /** @type {?number} */
    ability_question_9;
    /** @type {?number} */
    ability_question_10;
    /** @type {string} */
    qualify_assessment;
    /** @type {string} */
    recommendation;
    /** @type {string} */
    recommendation_details;
    /** @type {boolean} */
    is_regent_alum;
    /** @type {boolean} */
    is_complete;
    /** @type {?string} */
    email_sent;
    /** @type {?string} */
    submitted_date;
}
export class CRMApplicationRequirementCreateRequest {
    /** @param {{status?:string,requirement_name?:string,requested_date?:string,received_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    status;
    /** @type {string} */
    requirement_name;
    /** @type {?string} */
    requested_date;
    /** @type {?string} */
    received_date;
}
export class CRMEducationUpsertRequest {
    /** @param {{regent_id?:number,import_id?:number,institution_regent_id?:number,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?:number,is_final?:boolean,is_regis_external_degree?:boolean,start_year?:number,end_year?:number,month_graduated?:number,year_graduated?:number,added_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    import_id;
    /** @type {?number} */
    institution_regent_id;
    /** @type {string} */
    application_guid;
    /** @type {string} */
    degree_status;
    /** @type {string} */
    degree_type;
    /** @type {string} */
    unofficial_institution_name;
    /** @type {string} */
    unofficial_degree_name;
    /** @type {string} */
    degree_name;
    /** @type {string} */
    degree_code;
    /** @type {string} */
    description;
    /** @type {string} */
    major;
    /** @type {string} */
    second_major;
    /** @type {?number} */
    cumulative_gpa;
    /** @type {boolean} */
    is_final;
    /** @type {boolean} */
    is_regis_external_degree;
    /** @type {?number} */
    start_year;
    /** @type {?number} */
    end_year;
    /** @type {?number} */
    month_graduated;
    /** @type {?number} */
    year_graduated;
    /** @type {?string} */
    added_date;
}
export class CRMApplicationCreateRequest {
    /** @param {{regent_id?:number,import_id?:number,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?:boolean,native_language?:string,birth_place?:string,residency_status?:string,language_test_exemption_request_date?:string,language_test_exemption_decision_date?:string,language_test_exemption_decision?:string,language_test_comment?:string,language_tests?:CRMApplicationLanguageTestCreateRequest[],references?:CRMApplicationRefereeCreateRequest[],requirements?:CRMApplicationRequirementCreateRequest[],education?:CRMEducationUpsertRequest[],church_attended?:string,pastor_first_name?:string,pastor_last_name?:string,has_impairment?:boolean,impairment_description?:string,apply_for_financial_aid?:boolean,financial_description?:string,employment_years?:number,employment_description?:string,church_volunteer_years?:number,church_volunteer_description?:string,other_volunteer_years?:number,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?:boolean,transfer_credits?:boolean,applicant_comments?:string,cumulative_undergraduate_gpa?:number,cumulative_graduate_gpa?:number,conditional_admission?:boolean,conditional_admission_reason?:string[],admission_notes?:string,admission_decision_notes?:string,withdrawn_reason?:string,submitted?:string,paid?:string,reviewed?:string,completed?:string,rejected?:string,admitted?:string,postponed?:string,withdrawn?:string,confirmed?:string,read_theological_position?:string,current_status?:string,image_base64?:string,promo_code?:string,added_date?:string,last_contacted_date?:string,owning_username?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {number} */
    import_id;
    /** @type {string} */
    application_name;
    /** @type {string} */
    academic_program;
    /** @type {string} */
    start_term;
    /** @type {string} */
    location;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    former_name;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    spouse_name;
    /** @type {string} */
    children;
    /** @type {boolean} */
    native_english_speaker;
    /** @type {string} */
    native_language;
    /** @type {string} */
    birth_place;
    /** @type {string} */
    residency_status;
    /** @type {?string} */
    language_test_exemption_request_date;
    /** @type {?string} */
    language_test_exemption_decision_date;
    /** @type {string} */
    language_test_exemption_decision;
    /** @type {string} */
    language_test_comment;
    /** @type {CRMApplicationLanguageTestCreateRequest[]} */
    language_tests;
    /** @type {CRMApplicationRefereeCreateRequest[]} */
    references;
    /** @type {CRMApplicationRequirementCreateRequest[]} */
    requirements;
    /** @type {CRMEducationUpsertRequest[]} */
    education;
    /** @type {string} */
    church_attended;
    /** @type {string} */
    pastor_first_name;
    /** @type {string} */
    pastor_last_name;
    /** @type {boolean} */
    has_impairment;
    /** @type {string} */
    impairment_description;
    /** @type {boolean} */
    apply_for_financial_aid;
    /** @type {string} */
    financial_description;
    /** @type {?number} */
    employment_years;
    /** @type {string} */
    employment_description;
    /** @type {?number} */
    church_volunteer_years;
    /** @type {string} */
    church_volunteer_description;
    /** @type {?number} */
    other_volunteer_years;
    /** @type {string} */
    other_volunteer_description;
    /** @type {string} */
    accomplishments_description;
    /** @type {string} */
    what_other_graduate_schools_are_you_apply;
    /** @type {string} */
    what_else_interests_you_about_regent;
    /** @type {string} */
    heard_about_regent_from_book;
    /** @type {string} */
    heard_about_regent_from_event;
    /** @type {string} */
    heard_about_regent_from_organization;
    /** @type {string} */
    heard_about_regent_from_person;
    /** @type {string} */
    heard_about_regent_from_website_pub;
    /** @type {string[]} */
    what_interests_you_about_regent;
    /** @type {string} */
    what_else_brought_you_to_regent;
    /** @type {boolean} */
    start_via_distance_ed;
    /** @type {boolean} */
    transfer_credits;
    /** @type {string} */
    applicant_comments;
    /** @type {?number} */
    cumulative_undergraduate_gpa;
    /** @type {?number} */
    cumulative_graduate_gpa;
    /** @type {boolean} */
    conditional_admission;
    /** @type {string[]} */
    conditional_admission_reason;
    /** @type {string} */
    admission_notes;
    /** @type {string} */
    admission_decision_notes;
    /** @type {string} */
    withdrawn_reason;
    /** @type {?string} */
    submitted;
    /** @type {?string} */
    paid;
    /** @type {?string} */
    reviewed;
    /** @type {?string} */
    completed;
    /** @type {?string} */
    rejected;
    /** @type {?string} */
    admitted;
    /** @type {?string} */
    postponed;
    /** @type {?string} */
    withdrawn;
    /** @type {?string} */
    confirmed;
    /** @type {?string} */
    read_theological_position;
    /** @type {string} */
    current_status;
    /** @type {string} */
    image_base64;
    /** @type {string} */
    promo_code;
    /** @type {string} */
    added_date;
    /** @type {?string} */
    last_contacted_date;
    /** @type {string} */
    owning_username;
}
export class CRMApplicationUpsertMultipleRequest {
    /** @param {{applications?:CRMApplicationCreateRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CRMApplicationCreateRequest[]} */
    applications;
}

JavaScript CRMApplicationUpsertMultipleRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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-01T00:00:00.0000000","language_test_exemption_decision_date":"0001-01-01T00:00:00.0000000","language_test_exemption_decision":"String","language_test_comment":"String","language_tests":[{"type":"String","test_date":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","submitted_date":"0001-01-01T00:00:00.0000000"}],"requirements":[{"status":"String","requirement_name":"String","requested_date":"0001-01-01T00:00:00.0000000","received_date":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","paid":"0001-01-01T00:00:00.0000000","reviewed":"0001-01-01T00:00:00.0000000","completed":"0001-01-01T00:00:00.0000000","rejected":"0001-01-01T00:00:00.0000000","admitted":"0001-01-01T00:00:00.0000000","postponed":"0001-01-01T00:00:00.0000000","withdrawn":"0001-01-01T00:00:00.0000000","confirmed":"0001-01-01T00:00:00.0000000","read_theological_position":"0001-01-01T00:00:00.0000000","current_status":"String","image_base64":"String","promo_code":"String","added_date":"0001-01-01T00:00:00.0000000","last_contacted_date":"0001-01-01T00:00:00.0000000","owning_username":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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