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 Foundation
import ServiceStack

public class CRMContactRequest : Codable
{
    public var regent_id:Int

    required public init(){}
}

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

    required public init(){}
}


Swift 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"}