Party

Accepted Query Formats

Required Fields

Each party record must contain either:

• A Company Name or
• A Given Name and Surname

All other fields are optional.

Examples

Retrieve a single party record in XML format:

$ curl -i --header "VERSACCOUNTS_AUTHORIZATION:409696900e0b3f5a4297e3cd5823f734f0095e66" https://api_host/v1/party/544.xml

Retrieve all parties in XML format:

$ curl -i --header "VERSACCOUNTS_AUTHORIZATION:409696900e0b3f5a4297e3cd5823f734f0095e66" https://api_host/v1/party.xml

<?xml version="1.0" encoding="UTF-8"?>
<parties type="array">
  <party>
    <id type="integer">9407</id>
    <company-name>Paragon Sales Inc.</company-name>
    <surname>Bill</surname>
    <given-name>Lastman</given-name>
    <address-line-1>123 Front Street</address-line-1>
    <address-line-2>Suite 16</address-line-2>
    <address-line-3>PO Box 444</address-line-3>
    <postal-zip-code>K2B 1R5</postal-zip-code>
    <contact-number-1>888-123-4567</contact-number-1>
    <contact-number-2>866-123-5678</contact-number-2>
    <email>bill@paragon.com</email>
    <province-state>Ontario</province-state>
    <city nil="true">Ottawa</city>
    <country nil="true">Canada</country>
    <practical-name>Paragon Sales Inc.</practical-name>
  </party>
  <party>
    <id type="integer">4995</id>
    <company-name>Transformative Renovations</company-name>
    <surname>Laplace</surname>
    <given-name>Mac</given-name>
    <address-line-1>1233 High Bridge Road</address-line-1>
    <address-line-2></address-line-2>
    <address-line-3></address-line-3>
    <postal-zip-code></postal-zip-code>
    <contact-number-1>604-123-1234</contact-number-1>
    <contact-number-2></contact-number-2>
    <email>laplace.transforms@telus.net</email>
    <province-state>British Columbia</province-state>
    <city nil="true"></city>
    <country nil="true"></country>
    <practical-name>Transformative Renovations</practical-name>
  </party>
  <party>
    <id type="integer">4994</id>
    <company-name>Transformative Renovations</company-name>
    <surname>Laplace</surname>
    <given-name>Pierre-Simon</given-name>
    <address-line-1>123 Fiction Way</address-line-1>
    <address-line-2></address-line-2>
    <address-line-3></address-line-3>
    <postal-zip-code></postal-zip-code>
    <contact-number-1>604-123-1234</contact-number-1>
    <contact-number-2></contact-number-2>
    <email>laplace@telus.net</email>
    <province-state>BC</province-state>
    <city nil="true"></city>
    <country nil="true"></country>
    <practical-name>Transformative Renovations</practical-name>
  </party>
   ...
  <party>
    <id type="integer">5204</id>
    <company-name>Coyote Dream Homes</company-name>
    <surname>Wile E.</surname>
    <given-name>Coyote</given-name>
    <address-line-1>123 Canyon Way</address-line-1>
    <address-line-2></address-line-2>
    <address-line-3></address-line-3>
    <postal-zip-code></postal-zip-code>
    <contact-number-1>604.123.1234</contact-number-1>
    <contact-number-2></contact-number-2>
    <email></email>
    <province-state>BC</province-state>
    <city nil="true"></city>
    <country nil="true"></country>
    <practical-name>Coyote Dream Homes</practical-name>
  </party>
</parties>