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

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

    public constructor(init?: Partial<CRMContactResponse>) { (Object as any).assign(this, init); }
}

export class CRMContactSpouseRequest
{
    public regent_id: number;

    public constructor(init?: Partial<CRMContactSpouseRequest>) { (Object as any).assign(this, init); }
}

TypeScript CRMContactSpouseRequest 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}/Spouse 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"}