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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMApplicationLanguageTestCreateRequest:
    type: Optional[str] = None
    test_date: Optional[datetime.datetime] = None
    score: Optional[Decimal] = None
    applicant_defined: bool = False
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMApplicationRefereeCreateRequest:
    import_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    job_title: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    type: Optional[str] = None
    full_name: Optional[str] = None
    position: Optional[str] = None
    organization: Optional[str] = None
    email_from_referee: Optional[str] = None
    relationship: Optional[str] = None
    relationship_details: Optional[str] = None
    personal_evaluation: Optional[str] = None
    ability_question_1: Optional[int] = None
    ability_question_2: Optional[int] = None
    ability_question_3: Optional[int] = None
    ability_question_4: Optional[int] = None
    ability_question_5: Optional[int] = None
    ability_question_6: Optional[int] = None
    ability_question_7: Optional[int] = None
    ability_question_8: Optional[int] = None
    ability_question_9: Optional[int] = None
    ability_question_10: Optional[int] = None
    qualify_assessment: Optional[str] = None
    recommendation: Optional[str] = None
    recommendation_details: Optional[str] = None
    is_regent_alum: bool = False
    is_complete: bool = False
    email_sent: Optional[datetime.datetime] = None
    submitted_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMApplicationRequirementCreateRequest:
    status: Optional[str] = None
    requirement_name: Optional[str] = None
    requested_date: Optional[datetime.datetime] = None
    received_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMEducationUpsertRequest:
    regent_id: int = 0
    import_id: Optional[int] = None
    institution_regent_id: Optional[int] = None
    application_guid: Optional[str] = None
    degree_status: Optional[str] = None
    degree_type: Optional[str] = None
    unofficial_institution_name: Optional[str] = None
    unofficial_degree_name: Optional[str] = None
    degree_name: Optional[str] = None
    degree_code: Optional[str] = None
    description: Optional[str] = None
    major: Optional[str] = None
    second_major: Optional[str] = None
    cumulative_gpa: Optional[Decimal] = None
    is_final: bool = False
    is_regis_external_degree: bool = False
    start_year: Optional[int] = None
    end_year: Optional[int] = None
    month_graduated: Optional[int] = None
    year_graduated: Optional[int] = None
    added_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMApplicationCreateRequest:
    regent_id: int = 0
    import_id: int = 0
    application_name: Optional[str] = None
    academic_program: Optional[str] = None
    start_term: Optional[str] = None
    location: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    former_name: Optional[str] = None
    citizenship: Optional[str] = None
    citizenship_other: Optional[str] = None
    permanent_resident: Optional[str] = None
    spouse_name: Optional[str] = None
    children: Optional[str] = None
    native_english_speaker: bool = False
    native_language: Optional[str] = None
    birth_place: Optional[str] = None
    residency_status: Optional[str] = None
    language_test_exemption_request_date: Optional[datetime.datetime] = None
    language_test_exemption_decision_date: Optional[datetime.datetime] = None
    language_test_exemption_decision: Optional[str] = None
    language_test_comment: Optional[str] = None
    language_tests: Optional[List[CRMApplicationLanguageTestCreateRequest]] = None
    references: Optional[List[CRMApplicationRefereeCreateRequest]] = None
    requirements: Optional[List[CRMApplicationRequirementCreateRequest]] = None
    education: Optional[List[CRMEducationUpsertRequest]] = None
    church_attended: Optional[str] = None
    pastor_first_name: Optional[str] = None
    pastor_last_name: Optional[str] = None
    has_impairment: bool = False
    impairment_description: Optional[str] = None
    apply_for_financial_aid: bool = False
    financial_description: Optional[str] = None
    employment_years: Optional[Decimal] = None
    employment_description: Optional[str] = None
    church_volunteer_years: Optional[Decimal] = None
    church_volunteer_description: Optional[str] = None
    other_volunteer_years: Optional[Decimal] = None
    other_volunteer_description: Optional[str] = None
    accomplishments_description: Optional[str] = None
    what_other_graduate_schools_are_you_apply: Optional[str] = None
    what_else_interests_you_about_regent: Optional[str] = None
    heard_about_regent_from_book: Optional[str] = None
    heard_about_regent_from_event: Optional[str] = None
    heard_about_regent_from_organization: Optional[str] = None
    heard_about_regent_from_person: Optional[str] = None
    heard_about_regent_from_website_pub: Optional[str] = None
    what_interests_you_about_regent: Optional[List[str]] = None
    what_else_brought_you_to_regent: Optional[str] = None
    start_via_distance_ed: bool = False
    transfer_credits: bool = False
    applicant_comments: Optional[str] = None
    cumulative_undergraduate_gpa: Optional[Decimal] = None
    cumulative_graduate_gpa: Optional[Decimal] = None
    conditional_admission: bool = False
    conditional_admission_reason: Optional[List[str]] = None
    admission_notes: Optional[str] = None
    admission_decision_notes: Optional[str] = None
    withdrawn_reason: Optional[str] = None
    submitted: Optional[datetime.datetime] = None
    paid: Optional[datetime.datetime] = None
    reviewed: Optional[datetime.datetime] = None
    completed: Optional[datetime.datetime] = None
    rejected: Optional[datetime.datetime] = None
    admitted: Optional[datetime.datetime] = None
    postponed: Optional[datetime.datetime] = None
    withdrawn: Optional[datetime.datetime] = None
    confirmed: Optional[datetime.datetime] = None
    read_theological_position: Optional[datetime.datetime] = None
    current_status: Optional[str] = None
    image_base64: Optional[str] = None
    promo_code: Optional[str] = None
    added_date: datetime.datetime = datetime.datetime(1, 1, 1)
    last_contacted_date: Optional[datetime.datetime] = None
    owning_username: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMApplicationUpsertMultipleRequest:
    applications: Optional[List[CRMApplicationCreateRequest]] = None

Python CRMApplicationUpsertMultipleRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CRMApplicationUpsertMultipleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <applications>
    <CRMApplicationCreateRequest>
      <academic_program>String</academic_program>
      <accomplishments_description>String</accomplishments_description>
      <added_date>0001-01-01T00:00:00</added_date>
      <addr1>String</addr1>
      <addr2>String</addr2>
      <admission_decision_notes>String</admission_decision_notes>
      <admission_notes>String</admission_notes>
      <admitted>0001-01-01T00:00:00</admitted>
      <applicant_comments>String</applicant_comments>
      <application_name>String</application_name>
      <apply_for_financial_aid>false</apply_for_financial_aid>
      <birth_place>String</birth_place>
      <children>String</children>
      <church_attended>String</church_attended>
      <church_volunteer_description>String</church_volunteer_description>
      <church_volunteer_years>0</church_volunteer_years>
      <citizenship>String</citizenship>
      <citizenship_other>String</citizenship_other>
      <city>String</city>
      <code>String</code>
      <completed>0001-01-01T00:00:00</completed>
      <conditional_admission>false</conditional_admission>
      <conditional_admission_reason xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </conditional_admission_reason>
      <confirmed>0001-01-01T00:00:00</confirmed>
      <country>String</country>
      <cumulative_graduate_gpa>0</cumulative_graduate_gpa>
      <cumulative_undergraduate_gpa>0</cumulative_undergraduate_gpa>
      <current_status>String</current_status>
      <education>
        <CRMEducationUpsertRequest>
          <added_date>0001-01-01T00:00:00</added_date>
          <application_guid>String</application_guid>
          <cumulative_gpa>0</cumulative_gpa>
          <degree_code>String</degree_code>
          <degree_name>String</degree_name>
          <degree_status>String</degree_status>
          <degree_type>String</degree_type>
          <description>String</description>
          <end_year>0</end_year>
          <import_id>0</import_id>
          <institution_regent_id>0</institution_regent_id>
          <is_final>false</is_final>
          <is_regis_external_degree>false</is_regis_external_degree>
          <major>String</major>
          <month_graduated>0</month_graduated>
          <regent_id>0</regent_id>
          <second_major>String</second_major>
          <start_year>0</start_year>
          <unofficial_degree_name>String</unofficial_degree_name>
          <unofficial_institution_name>String</unofficial_institution_name>
          <year_graduated>0</year_graduated>
        </CRMEducationUpsertRequest>
      </education>
      <employment_description>String</employment_description>
      <employment_years>0</employment_years>
      <financial_description>String</financial_description>
      <former_name>String</former_name>
      <has_impairment>false</has_impairment>
      <heard_about_regent_from_book>String</heard_about_regent_from_book>
      <heard_about_regent_from_event>String</heard_about_regent_from_event>
      <heard_about_regent_from_organization>String</heard_about_regent_from_organization>
      <heard_about_regent_from_person>String</heard_about_regent_from_person>
      <heard_about_regent_from_website_pub>String</heard_about_regent_from_website_pub>
      <image_base64>String</image_base64>
      <impairment_description>String</impairment_description>
      <import_id>0</import_id>
      <language_test_comment>String</language_test_comment>
      <language_test_exemption_decision>String</language_test_exemption_decision>
      <language_test_exemption_decision_date>0001-01-01T00:00:00</language_test_exemption_decision_date>
      <language_test_exemption_request_date>0001-01-01T00:00:00</language_test_exemption_request_date>
      <language_tests>
        <CRMApplicationLanguageTestCreateRequest>
          <applicant_defined>false</applicant_defined>
          <score>0</score>
          <status>String</status>
          <test_date>0001-01-01T00:00:00</test_date>
          <type>String</type>
        </CRMApplicationLanguageTestCreateRequest>
      </language_tests>
      <last_contacted_date>0001-01-01T00:00:00</last_contacted_date>
      <location>String</location>
      <native_english_speaker>false</native_english_speaker>
      <native_language>String</native_language>
      <other_volunteer_description>String</other_volunteer_description>
      <other_volunteer_years>0</other_volunteer_years>
      <owning_username>String</owning_username>
      <paid>0001-01-01T00:00:00</paid>
      <pastor_first_name>String</pastor_first_name>
      <pastor_last_name>String</pastor_last_name>
      <permanent_resident>String</permanent_resident>
      <postponed>0001-01-01T00:00:00</postponed>
      <promo_code>String</promo_code>
      <read_theological_position>0001-01-01T00:00:00</read_theological_position>
      <references>
        <CRMApplicationRefereeCreateRequest>
          <ability_question_1>0</ability_question_1>
          <ability_question_10>0</ability_question_10>
          <ability_question_2>0</ability_question_2>
          <ability_question_3>0</ability_question_3>
          <ability_question_4>0</ability_question_4>
          <ability_question_5>0</ability_question_5>
          <ability_question_6>0</ability_question_6>
          <ability_question_7>0</ability_question_7>
          <ability_question_8>0</ability_question_8>
          <ability_question_9>0</ability_question_9>
          <email>String</email>
          <email_from_referee>String</email_from_referee>
          <email_sent>0001-01-01T00:00:00</email_sent>
          <first_name>String</first_name>
          <full_name>String</full_name>
          <import_id>0</import_id>
          <is_complete>false</is_complete>
          <is_regent_alum>false</is_regent_alum>
          <job_title>String</job_title>
          <last_name>String</last_name>
          <organization>String</organization>
          <personal_evaluation>String</personal_evaluation>
          <phone>String</phone>
          <position>String</position>
          <qualify_assessment>String</qualify_assessment>
          <recommendation>String</recommendation>
          <recommendation_details>String</recommendation_details>
          <relationship>String</relationship>
          <relationship_details>String</relationship_details>
          <submitted_date>0001-01-01T00:00:00</submitted_date>
          <type>String</type>
        </CRMApplicationRefereeCreateRequest>
      </references>
      <regent_id>0</regent_id>
      <rejected>0001-01-01T00:00:00</rejected>
      <requirements>
        <CRMApplicationRequirementCreateRequest>
          <received_date>0001-01-01T00:00:00</received_date>
          <requested_date>0001-01-01T00:00:00</requested_date>
          <requirement_name>String</requirement_name>
          <status>String</status>
        </CRMApplicationRequirementCreateRequest>
      </requirements>
      <residency_status>String</residency_status>
      <reviewed>0001-01-01T00:00:00</reviewed>
      <spouse_name>String</spouse_name>
      <start_term>String</start_term>
      <start_via_distance_ed>false</start_via_distance_ed>
      <state>String</state>
      <submitted>0001-01-01T00:00:00</submitted>
      <transfer_credits>false</transfer_credits>
      <what_else_brought_you_to_regent>String</what_else_brought_you_to_regent>
      <what_else_interests_you_about_regent>String</what_else_interests_you_about_regent>
      <what_interests_you_about_regent xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </what_interests_you_about_regent>
      <what_other_graduate_schools_are_you_apply>String</what_other_graduate_schools_are_you_apply>
      <withdrawn>0001-01-01T00:00:00</withdrawn>
      <withdrawn_reason>String</withdrawn_reason>
    </CRMApplicationCreateRequest>
  </applications>
</CRMApplicationUpsertMultipleRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <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>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>