regis

<back to all web services

CRMContactSpouseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/{regent_id}/Spouse
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.DynamicsCRM.Requests
Imports regis.DynamicsCRM.Responses

Namespace Global

    Namespace regis.DynamicsCRM.Requests

        Public Partial Class CRMContactSpouseRequest
            Public Overridable Property regent_id As Integer
        End Class
    End Namespace

    Namespace regis.DynamicsCRM.Responses

        Public Partial Class CRMContactResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property guid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property full_name As String
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property middle_name As String
            Public Overridable Property preferred_name As String
            Public Overridable Property former_name As String
            Public Overridable Property prefix As String
            Public Overridable Property addressee As String
            Public Overridable Property primary_salutation As String
            Public Overridable Property spouse_name As String
            Public Overridable Property spouse_is_main_contact As Boolean
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property code As String
            Public Overridable Property citizenship As String
            Public Overridable Property citizenship_other As String
            Public Overridable Property permanent_resident As String
            Public Overridable Property dob As Nullable(Of Date)
            Public Overridable Property birth_month As String
            Public Overridable Property deceased_date As Nullable(Of Date)
            Public Overridable Property age As Nullable(Of Integer)
            Public Overridable Property denomination As String
            Public Overridable Property connection_to_regent As String
            Public Overridable Property student_status As String
            Public Overridable Property student_segment As String
            Public Overridable Property engagement_score As Nullable(Of Integer)
            Public Overridable Property reason_added As String
            Public Overridable Property gender As String
            Public Overridable Property marital_status As String
            Public Overridable Property financial_aid_received As Boolean
            Public Overridable Property is_applicant As Boolean
            Public Overridable Property solicitation_method As String
            Public Overridable Property solicitation_exceptions As String
            Public Overridable Property campaign_monitor_optin As Boolean
            Public Overridable Property campaign_monitor_suppressed As Boolean
            Public Overridable Property campaign_monitor_last_event_date As Nullable(Of Date)
            Public Overridable Property campaign_monitor_last_reframe_purchase_dt As Nullable(Of Date)
            Public Overridable Property consent_to_receive_bulk_email As String
            Public Overridable Property last_consent_source As String
            Public Overridable Property last_consent_date As Nullable(Of Date)
            Public Overridable Property campaign_monitor_lists As String
            Public Overridable Property email As String
            Public Overridable Property email_secondary As String
            Public Overridable Property phone_home As String
            Public Overridable Property phone_bus As String
            Public Overridable Property phone_cell As String
            Public Overridable Property no_mail As Boolean
            Public Overridable Property no_email As Boolean
            Public Overridable Property no_bulk_email As Boolean
            Public Overridable Property no_phone As Boolean
            Public Overridable Property no_marketing_materials As Boolean
            Public Overridable Property prefers_email As Boolean
            Public Overridable Property prefers_phone As Boolean
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property current_program As String
            Public Overridable Property total_audit_hours As Nullable(Of Decimal)
            Public Overridable Property total_credit_hours As Nullable(Of Decimal)
            Public Overridable Property last_credit_class As Nullable(Of Date)
            Public Overridable Property last_audit_class As Nullable(Of Date)
            Public Overridable Property last_oncampus_class As Nullable(Of Date)
            Public Overridable Property last_distance_education_class As Nullable(Of Date)
            Public Overridable Property last_evening_weekend_class As Nullable(Of Date)
            Public Overridable Property last_summer_class As Nullable(Of Date)
            Public Overridable Property last_marketplace_class As Nullable(Of Date)
            Public Overridable Property last_anglican_studies_class As Nullable(Of Date)
            Public Overridable Property all_terms_registered As String
            Public Overridable Property all_terms_registered_onsite As String
            Public Overridable Property all_terms_registered_online As String
            Public Overridable Property has_regent_degree As Boolean
            Public Overridable Property owner_full_name As String
        End Class
    End Namespace
End Namespace

VB.NET CRMContactSpouseRequest 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/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>