API/Account/GetAccount

From Emersion
Revision as of 13:12, 12 May 2016 by JLee (talk) (new page created for GetAccount API function)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Purpose

Retrieve Contacts (Contact Identifier(s), Address(es), Phone Number(s), Email Address(es), Cumulus User(s)) and Organisation (Organisation Name(s) and its corresponding Organisation Registration Number(s), Address(es), Phone Number(s), Email Address(es)) that belongs to the Account ID supplied.


Inputs 

  <soapenv:Header/>
  <soapenv:Body>
     <acc:GetAccountRequest>
        <acc:AccountID>1234567</acc:AccountID>
     </acc:GetAccountRequest>
  </soapenv:Body>


Output 

  <SOAP-ENV:Body>
     <ns7:GetAccountResponse>
        <ns1:AccountID>1234567</ns1:AccountID>
        <ns1:AccountName>Emersion Support</ns1:AccountName>
        <ns1:AccountStatus>1</ns1:AccountStatus>
        <ns1:AccountType>3</ns1:AccountType>
        <ns1:Contact>
           <ns2:ContactID>122333</ns2:ContactID>
           <ns2:ContactCategory>Primary</ns2:ContactCategory>
           <ns2:ContactType/>
           <ns2:FirstName>Emersion</ns2:FirstName>
           <ns2:LastName>Support</ns2:LastName>
           <ns2:SalutationText>MR</ns2:SalutationText>
           <ns2:DateOfBirth>01-01-1980</ns2:DateOfBirth>
           <ns2:ContactIdentifier>
              <ns2:ContactIdentifierID>112233</ns2:ContactIdentifierID>
              <ns2:IdentifierTypeID>101</ns2:IdentifierTypeID>
              <ns2:IdentifierType>Drivers License</ns2:IdentifierType>
              <ns2:IsPrimary>1</ns2:IsPrimary>
              <ns2:IdentifierNumber>11223344</ns2:IdentifierNumber>
              <ns2:IdentifierState>Victoria</ns2:IdentifierState>
              <ns2:IdentifierCountry xsi:nil="true"/>
              <ns2:IdentifierStateOther xsi:nil="true"/>
              <ns2:LastUpdated>2016-01-01 12:00:01</ns2:LastUpdated>
           </ns2:ContactIdentifier>
           <ns2:Address>
              <ns3:FormattedAddress>Melbourne VIC 3000 Australia</ns3:FormattedAddress>
              <ns3:AddressID>123123</ns3:AddressID>
              <ns3:IsPrimary>1</ns3:IsPrimary>
              <ns3:AddressTypeDisplay>Unstructured Address</ns3:AddressTypeDisplay>
              <ns3:AddressType>Not stated/unknown</ns3:AddressType>
              <ns3:StreetName xsi:nil="true"/>
              <ns3:Country>Australia</ns3:Country>
              <ns3:UnstructuredAddressLine1>al1</ns3:UnstructuredAddressLine1>
              <ns3:UnstructuredAddressLine2>al2</ns3:UnstructuredAddressLine2>
              <ns3:Suburb>Melbourne</ns3:Suburb>
              <ns3:State>Victoria</ns3:State>
              <ns3:Postcode>3000</ns3:Postcode>
              <ns3:ValidatedFlag/>
              <ns3:LastUpdated>2016-01-01 12:00:01</ns3:LastUpdated>
           </ns2:Address>
           <ns2:PhoneNumber>
              <ns4:PhoneNumberID>223344</ns3:PhoneNumberID>
              <ns4:PhoneNumberTypeID>1</ns3:PhoneNumberTypeID>
              <ns4:PhoneNumberType>Mobile - Personal</ns3:PhoneNumberType>
              <ns4:IsPrimaryFlag>0</ns3:IsPrimaryFlag>
              <ns4:PhoneNumber>0412345678</ns3:PhoneNumber>
              <ns4:IsPreferredFlag>0</ns3:IsPreferredFlag>
           </ns2:PhoneNumber>
           <ns2:EmailAddress>
              <ns5:EmailAddressID>334455</ns4:EmailAddressID>
              <ns5:EmailAddress>emesupport@communitytelco.com.au</ns4:EmailAddress>
              <ns5:EmailAddressTypeID>101</ns4:EmailAddressTypeID>
              <ns5:EmailAddressType>Not stated</ns4:EmailAddressType>
              <ns5:IsPrimary>1</ns4:IsPrimary>
              <ns5:LastUpdated>2016-01-01 12:00:01</ns4:LastUpdated>
           </ns2:EmailAddress>
           <ns2:CumulusUser>
              <ns2:CumulusUserID>445566</ns2:CumulusUserID>
              <ns2:Username>emesupport@communitytelco.com.au</ns2:Username>
              <ns2:Password/>
              <ns2:IsLocked>0</ns2:IsLocked>
           </ns2:CumulusUser>
        </ns1:Contact>
        <ns1:Organisation>
           <ns6:OrganisationID>778899</ns6:OrganisationID>
           <ns6:OrganisationTradingName>Emersion</ns6:OrganisationTradingName>
           <ns6:LastUpdated>2016-01-01 12:00:01</ns6:LastUpdated>
           <ns6:OrganisationName>
              <ns6:OrganisationNameID>7788990</ns6:OrganisationNameID>
              <ns6:OrganisationName>Emersion Software Systems Pty Ltd</ns6:OrganisationName>
              <ns6:OrganisationTypeID>29</ns6:OrganisationTypeID>
              <ns6:OrganisationType>Co</ns6:OrganisationType>
              <ns6:LastUpdated>2016-01-01 12:00:01</ns6:LastUpdated>
           </ns6:OrganisationName>
           <ns6:Address>
              <ns3:FormattedAddress>Melbourne VIC 3000 Australia</ns3:FormattedAddress>
              <ns3:AddressID>123123</ns3:AddressID>
              <ns3:IsPrimary>1</ns3:IsPrimary>
              <ns3:AddressTypeDisplay>Unstructured Address</ns3:AddressTypeDisplay>
              <ns3:AddressType>Not stated/unknown</ns3:AddressType>
              <ns3:StreetName xsi:nil="true"/>
              <ns3:Country>Australia</ns3:Country>
              <ns3:UnstructuredAddressLine1>al1</ns3:UnstructuredAddressLine1>
              <ns3:UnstructuredAddressLine2>al2</ns3:UnstructuredAddressLine2>
              <ns3:Suburb>Melbourne</ns3:Suburb>
              <ns3:State>Victoria</ns3:State>
              <ns3:Postcode>3000</ns3:Postcode>
              <ns3:ValidatedFlag/>
              <ns3:LastUpdated>2016-01-01 12:00:01</ns3:LastUpdated>
           </ns6:Address>
           <ns6:PhoneNumber>
              <ns4:PhoneNumberID>223344</ns3:PhoneNumberID>
              <ns4:PhoneNumberTypeID>1</ns3:PhoneNumberTypeID>
              <ns4:PhoneNumberType>Mobile - Personal</ns3:PhoneNumberType>
              <ns4:IsPrimaryFlag>0</ns3:IsPrimaryFlag>
              <ns4:PhoneNumber>0412345678</ns3:PhoneNumber>
              <ns4:IsPreferredFlag>0</ns3:IsPreferredFlag>
           </ns6:PhoneNumber>
           <ns6:EmailAddress>
              <ns5:EmailAddressID>334455</ns4:EmailAddressID>
              <ns5:EmailAddress>emesupport@communitytelco.com.au</ns4:EmailAddress>
              <ns5:EmailAddressTypeID>101</ns4:EmailAddressTypeID>
              <ns5:EmailAddressType>Not stated</ns4:EmailAddressType>
              <ns5:IsPrimary>1</ns4:IsPrimary>
              <ns5:LastUpdated>2016-01-01 12:00:01</ns4:LastUpdated>
           </ns6:EmailAddress>
        </ns1:Organisation>
     </ns7:GetAccountResponse>
  </SOAP-ENV:Body>

Error String

  • "Invalid account ID: 1234567" - AccountID supplied does not exist or does not belong to the same parent Account as the API Caller.
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Account/GetAccount&oldid=4397"