regis

<back to all web services

CRMAccountRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Account/{regent_id}
CRMAccountRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idpathintNo
CRMAccountResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
guidformstringNo
regent_idformintNo
nameformstringNo
other_nameformstringNo
institution_namesformstringNo
business_typeformstringNo
regent_friendly_churchformstringNo
denominationformstringNo
reason_addedformstringNo
connection_to_regentformstringNo
educational_affiliationformstringNo
accreditation_statusformstringNo
accreditation_status_notesformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
emailformstringNo
solicitation_methodformstringNo
solicitation_exceptionsformstringNo
campaign_monitor_optinformboolNo
campaign_monitor_suppressedformboolNo
consent_to_receive_bulk_emailformstringNo
last_consent_sourceformstringNo
last_consent_dateformDateTime?No
campaign_monitor_listsformstringNo
phone_homeformstringNo
phone_busformstringNo
phone_cellformstringNo
no_mailformboolNo
no_emailformboolNo
no_bulk_emailformboolNo
no_phoneformboolNo
no_marketing_materialsformboolNo
prefers_emailformboolNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
owner_full_nameformstringNo

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/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>