| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Contact/{regent_id}/Spouse |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| regent_id | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| 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 .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"regent_id":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}