regis

<back to all web services

CRMContactUpdateNonBioAddressRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Contact/{guid}/UpdateNonBioAddress
"use strict";
export class CRMContactUpdateNonBioAddressRequest {
    /** @param {{guid?:string,regent_id?:number,birth_month?:string,age?:number,student_segment?:string,engagement_score?:number,financial_aid_received?:boolean,is_applicant?:boolean,solicitation_method?:string,campaign_monitor_optin?:boolean,campaign_monitor_suppressed?:boolean,campaign_monitor_last_event_date?:string,campaign_monitor_last_reframe_purchase_dt?:string,consent_to_receive_bulk_email?:string,last_consent_source?:string,last_consent_date?:string,campaign_monitor_lists?:string,current_program?:string,total_audit_hours?:number,total_credit_hours?:number,last_credit_class?:string,last_audit_class?:string,last_oncampus_class?:string,last_distance_education_class?:string,last_evening_weekend_class?:string,last_summer_class?:string,last_marketplace_class?:string,last_anglican_studies_class?:string,all_terms_registered?:string,all_terms_registered_onsite?:string,all_terms_registered_online?:string,has_regent_degree?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    birth_month;
    /** @type {?number} */
    age;
    /** @type {string} */
    student_segment;
    /** @type {?number} */
    engagement_score;
    /** @type {boolean} */
    financial_aid_received;
    /** @type {boolean} */
    is_applicant;
    /** @type {string} */
    solicitation_method;
    /** @type {boolean} */
    campaign_monitor_optin;
    /** @type {boolean} */
    campaign_monitor_suppressed;
    /** @type {?string} */
    campaign_monitor_last_event_date;
    /** @type {?string} */
    campaign_monitor_last_reframe_purchase_dt;
    /** @type {string} */
    consent_to_receive_bulk_email;
    /** @type {string} */
    last_consent_source;
    /** @type {?string} */
    last_consent_date;
    /** @type {string} */
    campaign_monitor_lists;
    /** @type {string} */
    current_program;
    /** @type {?number} */
    total_audit_hours;
    /** @type {?number} */
    total_credit_hours;
    /** @type {?string} */
    last_credit_class;
    /** @type {?string} */
    last_audit_class;
    /** @type {?string} */
    last_oncampus_class;
    /** @type {?string} */
    last_distance_education_class;
    /** @type {?string} */
    last_evening_weekend_class;
    /** @type {?string} */
    last_summer_class;
    /** @type {?string} */
    last_marketplace_class;
    /** @type {?string} */
    last_anglican_studies_class;
    /** @type {string} */
    all_terms_registered;
    /** @type {string} */
    all_terms_registered_onsite;
    /** @type {string} */
    all_terms_registered_online;
    /** @type {boolean} */
    has_regent_degree;
}

JavaScript CRMContactUpdateNonBioAddressRequest DTOs

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

HTTP + XML

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

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

<CRMContactUpdateNonBioAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <age>0</age>
  <all_terms_registered>String</all_terms_registered>
  <all_terms_registered_online>String</all_terms_registered_online>
  <all_terms_registered_onsite>String</all_terms_registered_onsite>
  <birth_month>String</birth_month>
  <campaign_monitor_last_event_date>0001-01-01T00:00:00</campaign_monitor_last_event_date>
  <campaign_monitor_last_reframe_purchase_dt>0001-01-01T00:00:00</campaign_monitor_last_reframe_purchase_dt>
  <campaign_monitor_lists>String</campaign_monitor_lists>
  <campaign_monitor_optin>false</campaign_monitor_optin>
  <campaign_monitor_suppressed>false</campaign_monitor_suppressed>
  <consent_to_receive_bulk_email>String</consent_to_receive_bulk_email>
  <current_program>String</current_program>
  <engagement_score>0</engagement_score>
  <financial_aid_received>false</financial_aid_received>
  <guid>String</guid>
  <has_regent_degree>false</has_regent_degree>
  <is_applicant>false</is_applicant>
  <last_anglican_studies_class>0001-01-01T00:00:00</last_anglican_studies_class>
  <last_audit_class>0001-01-01T00:00:00</last_audit_class>
  <last_consent_date>0001-01-01T00:00:00</last_consent_date>
  <last_consent_source>String</last_consent_source>
  <last_credit_class>0001-01-01T00:00:00</last_credit_class>
  <last_distance_education_class>0001-01-01T00:00:00</last_distance_education_class>
  <last_evening_weekend_class>0001-01-01T00:00:00</last_evening_weekend_class>
  <last_marketplace_class>0001-01-01T00:00:00</last_marketplace_class>
  <last_oncampus_class>0001-01-01T00:00:00</last_oncampus_class>
  <last_summer_class>0001-01-01T00:00:00</last_summer_class>
  <regent_id>0</regent_id>
  <solicitation_method>String</solicitation_method>
  <student_segment>String</student_segment>
  <total_audit_hours>0</total_audit_hours>
  <total_credit_hours>0</total_credit_hours>
</CRMContactUpdateNonBioAddressRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>