Veetro Web Service Methods
Click here for a complete list of operations.
GetPersons
[Permission: Employee, Credentials: Contacts.People.ViewFull/Limited]
Returns the Persons containing the provided EntityIDs. If fullDetails is False, Arrays/Collection
and non-essential attributes such as Addresses will not be populated (fullDetails=False is suitable
for listings where in-depth data is not required.) Non-employee users cannot access contact details
other than their own.
Please Note: The auto-generated SOAP examples do not include inherited properties such as EntityID,
Email, etc. Use a proper WSDL framework to generate XML or see GetEntity for XML node reference.
No more than 50 per batch.
Test
The test form is only available for methods with primitive types as parameters.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetPersons"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPersons xmlns="http://schema.veetro.com">
<EntityIDs>
<int>int</int>
<int>int</int>
</EntityIDs>
<fullDetails>boolean</fullDetails>
</GetPersons>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPersonsResponse xmlns="http://schema.veetro.com">
<GetPersonsResult>
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address xsi:nil="true" />
<Address xsi:nil="true" />
</Addresses>
<Subscriptions>
<Subscription xsi:nil="true" />
<Subscription xsi:nil="true" />
</Subscriptions>
<RelatedBranches>
<BranchResult xsi:nil="true" />
<BranchResult xsi:nil="true" />
</RelatedBranches>
</Person>
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address xsi:nil="true" />
<Address xsi:nil="true" />
</Addresses>
<Subscriptions>
<Subscription xsi:nil="true" />
<Subscription xsi:nil="true" />
</Subscriptions>
<RelatedBranches>
<BranchResult xsi:nil="true" />
<BranchResult xsi:nil="true" />
</RelatedBranches>
</Person>
</GetPersonsResult>
</GetPersonsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPersons xmlns="http://schema.veetro.com">
<EntityIDs>
<int>int</int>
<int>int</int>
</EntityIDs>
<fullDetails>boolean</fullDetails>
</GetPersons>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPersonsResponse xmlns="http://schema.veetro.com">
<GetPersonsResult>
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address xsi:nil="true" />
<Address xsi:nil="true" />
</Addresses>
<Subscriptions>
<Subscription xsi:nil="true" />
<Subscription xsi:nil="true" />
</Subscriptions>
<RelatedBranches>
<BranchResult xsi:nil="true" />
<BranchResult xsi:nil="true" />
</RelatedBranches>
</Person>
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address xsi:nil="true" />
<Address xsi:nil="true" />
</Addresses>
<Subscriptions>
<Subscription xsi:nil="true" />
<Subscription xsi:nil="true" />
</Subscriptions>
<RelatedBranches>
<BranchResult xsi:nil="true" />
<BranchResult xsi:nil="true" />
</RelatedBranches>
</Person>
</GetPersonsResult>
</GetPersonsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /xml/GetPersons?EntityIDs=string&EntityIDs=string&fullDetails=string HTTP/1.1 Host: admin.worketc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPerson xmlns="http://schema.veetro.com">
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
</Addresses>
<Subscriptions>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
</Subscriptions>
<RelatedBranches>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
</RelatedBranches>
</Person>
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
</Addresses>
<Subscriptions>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
</Subscriptions>
<RelatedBranches>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
</RelatedBranches>
</Person>
</ArrayOfPerson>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/GetPersons HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length EntityIDs=string&EntityIDs=string&fullDetails=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPerson xmlns="http://schema.veetro.com">
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
</Addresses>
<Subscriptions>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
</Subscriptions>
<RelatedBranches>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
</RelatedBranches>
</Person>
<Person>
<Title>string</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<Surname>string</Surname>
<Mobile>string</Mobile>
<Gender>Unspecified or Male or Female</Gender>
<Birthday>dateTime</Birthday>
<CompanyIDInheritPermissions>int</CompanyIDInheritPermissions>
<Addresses>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
<Address>
<AddressID>int</AddressID>
<AddressType>Home or Work or Billing</AddressType>
<Street>string</Street>
<Suburb>string</Suburb>
<StateOrProv>string</StateOrProv>
<PostalCode>string</PostalCode>
<Country>string</Country>
<Phone>string</Phone>
<PhoneExt>string</PhoneExt>
<Fax>string</Fax>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
<DateLastModified>dateTime</DateLastModified>
</Address>
</Addresses>
<Subscriptions>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
<Subscription>
<SubscriptionID>int</SubscriptionID>
<EntityID>int</EntityID>
<MailingListID>int</MailingListID>
<UnsubscribeDate>dateTime</UnsubscribeDate>
<MailingListName>string</MailingListName>
</Subscription>
</Subscriptions>
<RelatedBranches>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
<BranchResult>
<BranchName>string</BranchName>
<IsPrimaryBranch>boolean</IsPrimaryBranch>
<BranchLabel>string</BranchLabel>
<CompanyName>string</CompanyName>
<CompanyIndustry>string</CompanyIndustry>
<EntityID>int</EntityID>
<Position>string</Position>
<PositionStartDate>dateTime</PositionStartDate>
<IsPrimary>boolean</IsPrimary>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
</BranchResult>
</RelatedBranches>
</Person>
</ArrayOfPerson>