regis

<back to all web services

CRMContactRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/{regent_id}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CRMContactRequest
{
    var regent_id:Int? = null
}

open class CRMContactResponse
{
    var responseStatus:ResponseStatus? = null
    var guid:String? = null
    var regent_id:Int? = null
    var full_name:String? = null
    var first_name:String? = null
    var last_name:String? = null
    var middle_name:String? = null
    var preferred_name:String? = null
    var former_name:String? = null
    var prefix:String? = null
    var addressee:String? = null
    var primary_salutation:String? = null
    var spouse_name:String? = null
    var spouse_is_main_contact:Boolean? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var code:String? = null
    var citizenship:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var dob:Date? = null
    var birth_month:String? = null
    var deceased_date:Date? = null
    var age:Int? = null
    var denomination:String? = null
    var connection_to_regent:String? = null
    var student_status:String? = null
    var student_segment:String? = null
    var engagement_score:Int? = null
    var reason_added:String? = null
    var gender:String? = null
    var marital_status:String? = null
    var financial_aid_received:Boolean? = null
    var is_applicant:Boolean? = null
    var solicitation_method:String? = null
    var solicitation_exceptions:String? = null
    var campaign_monitor_optin:Boolean? = null
    var campaign_monitor_suppressed:Boolean? = null
    var campaign_monitor_last_event_date:Date? = null
    var campaign_monitor_last_reframe_purchase_dt:Date? = null
    var consent_to_receive_bulk_email:String? = null
    var last_consent_source:String? = null
    var last_consent_date:Date? = null
    var campaign_monitor_lists:String? = null
    var email:String? = null
    var email_secondary:String? = null
    var phone_home:String? = null
    var phone_bus:String? = null
    var phone_cell:String? = null
    var no_mail:Boolean? = null
    var no_email:Boolean? = null
    var no_bulk_email:Boolean? = null
    var no_phone:Boolean? = null
    var no_marketing_materials:Boolean? = null
    var prefers_email:Boolean? = null
    var prefers_phone:Boolean? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
    var current_program:String? = null
    var total_audit_hours:BigDecimal? = null
    var total_credit_hours:BigDecimal? = null
    var last_credit_class:Date? = null
    var last_audit_class:Date? = null
    var last_oncampus_class:Date? = null
    var last_distance_education_class:Date? = null
    var last_evening_weekend_class:Date? = null
    var last_summer_class:Date? = null
    var last_marketplace_class:Date? = null
    var last_anglican_studies_class:Date? = null
    var all_terms_registered:String? = null
    var all_terms_registered_onsite:String? = null
    var all_terms_registered_online:String? = null
    var has_regent_degree:Boolean? = null
    var owner_full_name:String? = null
}

Kotlin CRMContactRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /DynamicsCRM/Contact/{regent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"regent_id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"guid":"String","regent_id":0,"full_name":"String","first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","former_name":"String","prefix":"String","addressee":"String","primary_salutation":"String","spouse_name":"String","spouse_is_main_contact":false,"addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","birth_month":"String","deceased_date":"0001-01-01T00:00:00.0000000","age":0,"denomination":"String","connection_to_regent":"String","student_status":"String","student_segment":"String","engagement_score":0,"reason_added":"String","gender":"String","marital_status":"String","financial_aid_received":false,"is_applicant":false,"solicitation_method":"String","solicitation_exceptions":"String","campaign_monitor_optin":false,"campaign_monitor_suppressed":false,"campaign_monitor_last_event_date":"0001-01-01T00:00:00.0000000","campaign_monitor_last_reframe_purchase_dt":"0001-01-01T00:00:00.0000000","consent_to_receive_bulk_email":"String","last_consent_source":"String","last_consent_date":"0001-01-01T00:00:00.0000000","campaign_monitor_lists":"String","email":"String","email_secondary":"String","phone_home":"String","phone_bus":"String","phone_cell":"String","no_mail":false,"no_email":false,"no_bulk_email":false,"no_phone":false,"no_marketing_materials":false,"prefers_email":false,"prefers_phone":false,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","current_program":"String","total_audit_hours":0,"total_credit_hours":0,"last_credit_class":"0001-01-01T00:00:00.0000000","last_audit_class":"0001-01-01T00:00:00.0000000","last_oncampus_class":"0001-01-01T00:00:00.0000000","last_distance_education_class":"0001-01-01T00:00:00.0000000","last_evening_weekend_class":"0001-01-01T00:00:00.0000000","last_summer_class":"0001-01-01T00:00:00.0000000","last_marketplace_class":"0001-01-01T00:00:00.0000000","last_anglican_studies_class":"0001-01-01T00:00:00.0000000","all_terms_registered":"String","all_terms_registered_onsite":"String","all_terms_registered_online":"String","has_regent_degree":false,"owner_full_name":"String"}