| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Contact/{regent_id} |
|---|
namespace regis.DynamicsCRM.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CRMContactResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val guid:String = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val full_name:String = null with get,set
member val first_name:String = null with get,set
member val last_name:String = null with get,set
member val middle_name:String = null with get,set
member val preferred_name:String = null with get,set
member val former_name:String = null with get,set
member val prefix:String = null with get,set
member val addressee:String = null with get,set
member val primary_salutation:String = null with get,set
member val spouse_name:String = null with get,set
member val spouse_is_main_contact:Boolean = new Boolean() with get,set
member val addr1:String = null with get,set
member val addr2:String = null with get,set
member val city:String = null with get,set
member val state:String = null with get,set
member val country:String = null with get,set
member val code:String = null with get,set
member val citizenship:String = null with get,set
member val citizenship_other:String = null with get,set
member val permanent_resident:String = null with get,set
member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val birth_month:String = null with get,set
member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val age:Nullable<Int32> = new Nullable<Int32>() with get,set
member val denomination:String = null with get,set
member val connection_to_regent:String = null with get,set
member val student_status:String = null with get,set
member val student_segment:String = null with get,set
member val engagement_score:Nullable<Int32> = new Nullable<Int32>() with get,set
member val reason_added:String = null with get,set
member val gender:String = null with get,set
member val marital_status:String = null with get,set
member val financial_aid_received:Boolean = new Boolean() with get,set
member val is_applicant:Boolean = new Boolean() with get,set
member val solicitation_method:String = null with get,set
member val solicitation_exceptions:String = null with get,set
member val campaign_monitor_optin:Boolean = new Boolean() with get,set
member val campaign_monitor_suppressed:Boolean = new Boolean() with get,set
member val campaign_monitor_last_event_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val campaign_monitor_last_reframe_purchase_dt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val consent_to_receive_bulk_email:String = null with get,set
member val last_consent_source:String = null with get,set
member val last_consent_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val campaign_monitor_lists:String = null with get,set
member val email:String = null with get,set
member val email_secondary:String = null with get,set
member val phone_home:String = null with get,set
member val phone_bus:String = null with get,set
member val phone_cell:String = null with get,set
member val no_mail:Boolean = new Boolean() with get,set
member val no_email:Boolean = new Boolean() with get,set
member val no_bulk_email:Boolean = new Boolean() with get,set
member val no_phone:Boolean = new Boolean() with get,set
member val no_marketing_materials:Boolean = new Boolean() with get,set
member val prefers_email:Boolean = new Boolean() with get,set
member val prefers_phone:Boolean = new Boolean() with get,set
member val added_by:String = null with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val changed_by:String = null with get,set
member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val current_program:String = null with get,set
member val total_audit_hours:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val total_credit_hours:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val last_credit_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_audit_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_oncampus_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_distance_education_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_evening_weekend_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_summer_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_marketplace_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_anglican_studies_class:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val all_terms_registered:String = null with get,set
member val all_terms_registered_onsite:String = null with get,set
member val all_terms_registered_online:String = null with get,set
member val has_regent_degree:Boolean = new Boolean() with get,set
member val owner_full_name:String = null with get,set
[<AllowNullLiteral>]
type CRMContactRequest() =
member val regent_id:Int32 = new Int32() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
regent_id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
birth_month: String,
deceased_date: 0001-01-01,
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-01,
campaign_monitor_last_reframe_purchase_dt: 0001-01-01,
consent_to_receive_bulk_email: String,
last_consent_source: String,
last_consent_date: 0001-01-01,
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-01,
changed_by: String,
changed_date: 0001-01-01,
current_program: String,
total_audit_hours: 0,
total_credit_hours: 0,
last_credit_class: 0001-01-01,
last_audit_class: 0001-01-01,
last_oncampus_class: 0001-01-01,
last_distance_education_class: 0001-01-01,
last_evening_weekend_class: 0001-01-01,
last_summer_class: 0001-01-01,
last_marketplace_class: 0001-01-01,
last_anglican_studies_class: 0001-01-01,
all_terms_registered: String,
all_terms_registered_onsite: String,
all_terms_registered_online: String,
has_regent_degree: False,
owner_full_name: String
}