Required role: | REGISUserRole |
POST | /DynamicsCRM/Account/{regent_id} |
---|
"use strict";
export class CRMAccountResponse {
/** @param {{responseStatus?:ResponseStatus,guid?:string,regent_id?:number,name?:string,other_name?:string,institution_names?:string,business_type?:string,regent_friendly_church?:string,denomination?:string,reason_added?:string,connection_to_regent?:string,educational_affiliation?:string,accreditation_status?:string,accreditation_status_notes?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,email?:string,solicitation_method?:string,solicitation_exceptions?:string,campaign_monitor_optin?:boolean,campaign_monitor_suppressed?:boolean,consent_to_receive_bulk_email?:string,last_consent_source?:string,last_consent_date?:string,campaign_monitor_lists?:string,phone_home?:string,phone_bus?:string,phone_cell?:string,no_mail?:boolean,no_email?:boolean,no_bulk_email?:boolean,no_phone?:boolean,no_marketing_materials?:boolean,prefers_email?:boolean,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,owner_full_name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
guid;
/** @type {number} */
regent_id;
/** @type {string} */
name;
/** @type {string} */
other_name;
/** @type {string} */
institution_names;
/** @type {string} */
business_type;
/** @type {string} */
regent_friendly_church;
/** @type {string} */
denomination;
/** @type {string} */
reason_added;
/** @type {string} */
connection_to_regent;
/** @type {string} */
educational_affiliation;
/** @type {string} */
accreditation_status;
/** @type {string} */
accreditation_status_notes;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
code;
/** @type {string} */
email;
/** @type {string} */
solicitation_method;
/** @type {string} */
solicitation_exceptions;
/** @type {boolean} */
campaign_monitor_optin;
/** @type {boolean} */
campaign_monitor_suppressed;
/** @type {string} */
consent_to_receive_bulk_email;
/** @type {string} */
last_consent_source;
/** @type {?string} */
last_consent_date;
/** @type {string} */
campaign_monitor_lists;
/** @type {string} */
phone_home;
/** @type {string} */
phone_bus;
/** @type {string} */
phone_cell;
/** @type {boolean} */
no_mail;
/** @type {boolean} */
no_email;
/** @type {boolean} */
no_bulk_email;
/** @type {boolean} */
no_phone;
/** @type {boolean} */
no_marketing_materials;
/** @type {boolean} */
prefers_email;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
/** @type {string} */
owner_full_name;
}
export class CRMAccountRequest {
/** @param {{regent_id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
regent_id;
}
JavaScript CRMAccountRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /DynamicsCRM/Account/{regent_id} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CRMAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
<regent_id>0</regent_id>
</CRMAccountRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CRMAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <accreditation_status>String</accreditation_status> <accreditation_status_notes>String</accreditation_status_notes> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <addr1>String</addr1> <addr2>String</addr2> <business_type>String</business_type> <campaign_monitor_lists>String</campaign_monitor_lists> <campaign_monitor_optin>false</campaign_monitor_optin> <campaign_monitor_suppressed>false</campaign_monitor_suppressed> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <city>String</city> <code>String</code> <connection_to_regent>String</connection_to_regent> <consent_to_receive_bulk_email>String</consent_to_receive_bulk_email> <country>String</country> <denomination>String</denomination> <educational_affiliation>String</educational_affiliation> <email>String</email> <guid>String</guid> <institution_names>String</institution_names> <last_consent_date>0001-01-01T00:00:00</last_consent_date> <last_consent_source>String</last_consent_source> <name>String</name> <no_bulk_email>false</no_bulk_email> <no_email>false</no_email> <no_mail>false</no_mail> <no_marketing_materials>false</no_marketing_materials> <no_phone>false</no_phone> <other_name>String</other_name> <owner_full_name>String</owner_full_name> <phone_bus>String</phone_bus> <phone_cell>String</phone_cell> <phone_home>String</phone_home> <prefers_email>false</prefers_email> <reason_added>String</reason_added> <regent_friendly_church>String</regent_friendly_church> <regent_id>0</regent_id> <solicitation_exceptions>String</solicitation_exceptions> <solicitation_method>String</solicitation_method> <state>String</state> </CRMAccountResponse>