Difference between revisions of "API/Minimal/GetContactByAccountAndType"

Revision as of 16:15, 10 September 2014

Get Contact By Account And Type

Purpose Retrieve account contacts by account id. Optionally get based on contact type ( by ‘Primary’ or ‘Billing’ ) or specific contact id

Note: to get both contacts type (ContactTypeName) either leave blank or use ‘Any’).

Inputs

* AccountID : required
* ContactTypeName : optional  (if used accepted values are Primary or Billing or Any
* ContactId: optional 

        <soapenv:Header/>
              <soapenv:Body>
               <min:GetContactByAccountAndTypeRequest>
       	<AccountID>657996</AccountID>
       	<ContactTypeName></ContactTypeName>
      		<ContactId></ContactId>
     	</min:GetContactByAccountAndTypeRequest>
       </soapenv:Body>

Output

<SOAP-ENV:Body> <ns1:GetContactByAccountAndTypeResponse> <contactList> <![CDATA[<?xml version="1.0"?><contacts><contactType typeName="Primary"><contact firstName="Jack" middleName="" lastName="Casonato" jobTitle="" dateOfBirth="" driverLicense="" secretAnswer1="" secretAnswer2="" phonePassword="" doNotCall="" doNotEmail="" parentType="" parentId="0" accountUploadSource="" accountUploadSourceRef="" accessPassword="" dependent="" crmExportRef="" id="363104" emailAddress="jack@casonato.com.au" contactSalutation="MR"><phoneNumbers><phoneNumber number="0390234903" extension="" parentType="4" parentId="363104" crmExportRef="" phoneType="MainPhone"/></phoneNumbers><physicalAddresses><physicalAddress addressTypeNumber="" streetName="" streetNumberStart="" streetNumberEnd="" streetLotNumber="" suburb="Carlton" postcode="3053" addressComplexUnitNumber="" addressComplexLevelNumber="" addressSiteName="" addressBuildingName="" addressSiteLocation="" addressLine1="Level 2" addressLine2="88 Pelham Street" addressPostalDeliveryNumber="" parentType="4" parentId="363104" addressPhysicalStateOther="" dateFrom="" dateTo="" crmExportRef="" id="372132" simpleFullAddressLine=", Carlton VIC 3053 Australia" simpleAddressLine1="" addressPhysicalState="Victoria" addressDisplayType="Unstructured Address" country="Australia"/></physicalAddresses><object_properties/></contact></contactType><contactType typeName="Billing"><contact firstName="Joanne" middleName="" lastName="Casonato" jobTitle="" dateOfBirth="" driverLicense="" secretAnswer1="" secretAnswer2="" phonePassword="" doNotCall="" doNotEmail="" parentType="" parentId="0" accountUploadSource="" accountUploadSourceRef="" accessPassword="" dependent="" crmExportRef="" id="363105" emailAddress="joanne@casonato.com.au"><phoneNumbers><phoneNumber number="0390234903" extension="" parentType="4" parentId="363105" crmExportRef="" phoneType="MainPhone"/></phoneNumbers><physicalAddresses><physicalAddress addressTypeNumber="" streetName="" streetNumberStart="" streetNumberEnd="" streetLotNumber="" suburb="Carlton" postcode="3053" addressComplexUnitNumber="" addressComplexLevelNumber="" addressSiteName="" addressBuildingName="" addressSiteLocation="" addressLine1="Level 2" addressLine2="88 Pelham Street" addressPostalDeliveryNumber="" parentType="4" parentId="363105" addressPhysicalStateOther="" dateFrom="" dateTo="" crmExportRef="" id="372133" simpleFullAddressLine=", Carlton VIC 3053 Australia" simpleAddressLine1="" addressPhysicalState="Victoria" addressDisplayType="Unstructured Address" country="Australia"/></physicalAddresses><object_properties/></contact></contactType></contacts>]]> </contactList> </ns1:GetContactByAccountAndTypeResponse> </SOAP-ENV:Body>