regis

CRMContactSpouseRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/DynamicsCRM/Contact/{regent_id}/Spouse

**CRMContactSpouseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
regent_id	path	int	No

**CRMContactResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
guid	form	string	No
regent_id	form	int	No
full_name	form	string	No
first_name	form	string	No
last_name	form	string	No
middle_name	form	string	No
preferred_name	form	string	No
former_name	form	string	No
prefix	form	string	No
addressee	form	string	No
primary_salutation	form	string	No
spouse_name	form	string	No
spouse_is_main_contact	form	bool	No
addr1	form	string	No
addr2	form	string	No
city	form	string	No
state	form	string	No
country	form	string	No
code	form	string	No
citizenship	form	string	No
citizenship_other	form	string	No
permanent_resident	form	string	No
dob	form	DateTime?	No
birth_month	form	string	No
deceased_date	form	DateTime?	No
age	form	int?	No
denomination	form	string	No
connection_to_regent	form	string	No
student_status	form	string	No
student_segment	form	string	No
engagement_score	form	int?	No
reason_added	form	string	No
gender	form	string	No
marital_status	form	string	No
financial_aid_received	form	bool	No
is_applicant	form	bool	No
solicitation_method	form	string	No
solicitation_exceptions	form	string	No
campaign_monitor_optin	form	bool	No
campaign_monitor_suppressed	form	bool	No
campaign_monitor_last_event_date	form	DateTime?	No
campaign_monitor_last_reframe_purchase_dt	form	DateTime?	No
consent_to_receive_bulk_email	form	string	No
last_consent_source	form	string	No
last_consent_date	form	DateTime?	No
campaign_monitor_lists	form	string	No
email	form	string	No
email_secondary	form	string	No
phone_home	form	string	No
phone_bus	form	string	No
phone_cell	form	string	No
no_mail	form	bool	No
no_email	form	bool	No
no_bulk_email	form	bool	No
no_phone	form	bool	No
no_marketing_materials	form	bool	No
prefers_email	form	bool	No
prefers_phone	form	bool	No
added_by	form	string	No
added_date	form	DateTime?	No
changed_by	form	string	No
changed_date	form	DateTime?	No
current_program	form	string	No
total_audit_hours	form	decimal?	No
total_credit_hours	form	decimal?	No
last_credit_class	form	DateTime?	No
last_audit_class	form	DateTime?	No
last_oncampus_class	form	DateTime?	No
last_distance_education_class	form	DateTime?	No
last_evening_weekend_class	form	DateTime?	No
last_summer_class	form	DateTime?	No
last_marketplace_class	form	DateTime?	No
last_anglican_studies_class	form	DateTime?	No
all_terms_registered	form	string	No
all_terms_registered_onsite	form	string	No
all_terms_registered_online	form	string	No
has_regent_degree	form	bool	No
owner_full_name	form	string	No

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/Contact/{regent_id}/Spouse HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMContactSpouseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <regent_id>0</regent_id>
</CRMContactSpouseRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CRMContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.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>
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <addressee>String</addressee>
  <age>0</age>
  <all_terms_registered>String</all_terms_registered>
  <all_terms_registered_online>String</all_terms_registered_online>
  <all_terms_registered_onsite>String</all_terms_registered_onsite>
  <birth_month>String</birth_month>
  <campaign_monitor_last_event_date>0001-01-01T00:00:00</campaign_monitor_last_event_date>
  <campaign_monitor_last_reframe_purchase_dt>0001-01-01T00:00:00</campaign_monitor_last_reframe_purchase_dt>
  <campaign_monitor_lists>String</campaign_monitor_lists>
  <campaign_monitor_optin>false</campaign_monitor_optin>
  <campaign_monitor_suppressed>false</campaign_monitor_suppressed>
  <changed_by>String</changed_by>
  <changed_date>0001-01-01T00:00:00</changed_date>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <connection_to_regent>String</connection_to_regent>
  <consent_to_receive_bulk_email>String</consent_to_receive_bulk_email>
  <country>String</country>
  <current_program>String</current_program>
  <deceased_date>0001-01-01T00:00:00</deceased_date>
  <denomination>String</denomination>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <email_secondary>String</email_secondary>
  <engagement_score>0</engagement_score>
  <financial_aid_received>false</financial_aid_received>
  <first_name>String</first_name>
  <former_name>String</former_name>
  <full_name>String</full_name>
  <gender>String</gender>
  <guid>String</guid>
  <has_regent_degree>false</has_regent_degree>
  <is_applicant>false</is_applicant>
  <last_anglican_studies_class>0001-01-01T00:00:00</last_anglican_studies_class>
  <last_audit_class>0001-01-01T00:00:00</last_audit_class>
  <last_consent_date>0001-01-01T00:00:00</last_consent_date>
  <last_consent_source>String</last_consent_source>
  <last_credit_class>0001-01-01T00:00:00</last_credit_class>
  <last_distance_education_class>0001-01-01T00:00:00</last_distance_education_class>
  <last_evening_weekend_class>0001-01-01T00:00:00</last_evening_weekend_class>
  <last_marketplace_class>0001-01-01T00:00:00</last_marketplace_class>
  <last_name>String</last_name>
  <last_oncampus_class>0001-01-01T00:00:00</last_oncampus_class>
  <last_summer_class>0001-01-01T00:00:00</last_summer_class>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <no_bulk_email>false</no_bulk_email>
  <no_email>false</no_email>
  <no_mail>false</no_mail>
  <no_marketing_materials>false</no_marketing_materials>
  <no_phone>false</no_phone>
  <owner_full_name>String</owner_full_name>
  <permanent_resident>String</permanent_resident>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <preferred_name>String</preferred_name>
  <prefers_email>false</prefers_email>
  <prefers_phone>false</prefers_phone>
  <prefix>String</prefix>
  <primary_salutation>String</primary_salutation>
  <reason_added>String</reason_added>
  <regent_id>0</regent_id>
  <solicitation_exceptions>String</solicitation_exceptions>
  <solicitation_method>String</solicitation_method>
  <spouse_is_main_contact>false</spouse_is_main_contact>
  <spouse_name>String</spouse_name>
  <state>String</state>
  <student_segment>String</student_segment>
  <student_status>String</student_status>
  <total_audit_hours>0</total_audit_hours>
  <total_credit_hours>0</total_credit_hours>
</CRMContactResponse>