Difference between revisions of "API/Services/UpdateAccount"

From Emersion
Jump to: navigation, search
(Update Account)
Line 9: Line 9:
 
'''Inputs'''
 
'''Inputs'''
  
xmlns:ser="http://emersion.com.au/ServiceObjects">
+
<xmlns:ser="http://emersion.com.au/ServiceObjects">
 
   <soapenv:Header/>
 
   <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
Line 88: Line 88:
 
       </ser:UpdateComplexAccount>
 
       </ser:UpdateComplexAccount>
 
   </soapenv:Body>
 
   </soapenv:Body>
 +
 +
'''Example Validation Error'''
 +
    <SOAP-ENV:Body>
 +
      <SOAP-ENV:Fault>
 +
        <faultcode>SOAP-ENV:Client</faultcode>
 +
        <faultstring>Validation Error</faultstring>
 +
        <faultactor>http://emersion.com.au/Services</faultactor>
 +
        <detail>Invalid or Missing Account ID</detail>
 +
      </SOAP-ENV:Fault>
 +
 +
'''Output'''
 +
  <xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1="http://emersion.com.au/ServiceObjects">
 +
    <SOAP-ENV:Body>
 +
      <ns1:UpdateAccountResponse>
 +
        <ns1:Result>true</ns1:Result>
 +
      </ns1:UpdateAccountResponse>
 +
    </SOAP-ENV:Body>

Revision as of 16:38, 10 September 2014

Update Account

Purpose

This allows you to update the primary contact details of an existing account. It is quite similar to creating an account only it has to be performed with existing end user accounts. Please note that the same input rules from create account apply here with respect to account type, org information and org types. Account ID is a mandatory field and must be supplied – it is the same account ID returned when creating an account.

Inputs

<xmlns:ser="http://emersion.com.au/ServiceObjects">

  <soapenv:Header/>
  <soapenv:Body>
     <ser:UpdateComplexAccount>
        <ser:AccountID>?</ser:AccountID>
        <ser:AccountType>?</ser:AccountType>
        <ser:PrimaryContact>
           <ser:Detail>
              <ser:Title>?</ser:Title>
              <ser:FirstName>?</ser:FirstName>
              <ser:LastName>?</ser:LastName>
              <ser:AddressLine1>?</ser:AddressLine1>
              <ser:AddressLine2>?</ser:AddressLine2>
              <ser:AddressLine3>?</ser:AddressLine3>
              <ser:Suburb>?</ser:Suburb>
              <ser:State>?</ser:State>
              <ser:Postcode>?</ser:Postcode>
              <ser:Country>?</ser:Country>
              <ser:EmailAddress>?</ser:EmailAddress>
              <ser:PhoneNumber>?</ser:PhoneNumber>
              <ser:MobileNumber>?</ser:MobileNumber>
              <ser:FaxNumber>?</ser:FaxNumber>
              <ser:Website>?</ser:Website>
           </ser:Detail>
           <ser:CumulusUser>
              <ser:UserName>?</ser:UserName>
              <ser:Password>?</ser:Password>
           </ser:CumulusUser>
        </ser:PrimaryContact>
        <ser:AccountContactType>
           <ser:Type>?</ser:Type>
        </ser:AccountContactType>
        <ser:AccountOrganisation>
           <ser:OrgName>?</ser:OrgName>
           <ser:OrgTradingName>?</ser:OrgTradingName>
           <ser:OrgType>?</ser:OrgType>
           <ser:OrgIdentifier>?</ser:OrgIdentifier>
           <ser:OrgIdentifierType>?</ser:OrgIdentifierType>
        </ser:AccountOrganisation>
        <ser:BillingContact>
           <ser:Detail>
              <ser:Title>?</ser:Title>
              <ser:FirstName>?</ser:FirstName>
              <ser:LastName>?</ser:LastName>
              <ser:AddressLine1>?</ser:AddressLine1>
              <ser:AddressLine2>?</ser:AddressLine2>
              <ser:AddressLine3>?</ser:AddressLine3>
              <ser:Suburb>?</ser:Suburb>
              <ser:State>?</ser:State>
              <ser:Postcode>?</ser:Postcode>
              <ser:Country>?</ser:Country>
              <ser:EmailAddress>?</ser:EmailAddress>
              <ser:PhoneNumber>?</ser:PhoneNumber>
              <ser:MobileNumber>?</ser:MobileNumber>
              <ser:FaxNumber>?</ser:FaxNumber>
              <ser:Website>?</ser:Website>
           </ser:Detail>
        </ser:BillingContact>
        <ser:AccountReference>?</ser:AccountReference>
     </ser:UpdateComplexAccount>
  </soapenv:Body>

Example Validation Error

   <SOAP-ENV:Body>
     <SOAP-ENV:Fault>
        <faultcode>SOAP-ENV:Client</faultcode>
        <faultstring>Validation Error</faultstring>
        <faultactor>http://emersion.com.au/Services</faultactor>
        <detail>Invalid or Missing Account ID</detail>
     </SOAP-ENV:Fault>

Output

  <xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"     xmlns:ns1="http://emersion.com.au/ServiceObjects">
   <SOAP-ENV:Body>
     <ns1:UpdateAccountResponse>
        <ns1:Result>true</ns1:Result>
     </ns1:UpdateAccountResponse>
   </SOAP-ENV:Body>