Veetro Web Service Methods
Click here for a complete list of operations.
GetPersonWebSafe
[Permission: Anonymous]
Returns the Basic Person details for the provided EntityHashID. Never returns private data such as addresses etc.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/GetPersonWebSafe" <?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> <GetPersonWebSafe xmlns="http://schema.veetro.com"> <EntityHashID>string</EntityHashID> </GetPersonWebSafe> </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> <GetPersonWebSafeResponse xmlns="http://schema.veetro.com"> <GetPersonWebSafeResult> <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> </GetPersonWebSafeResult> </GetPersonWebSafeResponse> </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> <GetPersonWebSafe xmlns="http://schema.veetro.com"> <EntityHashID>string</EntityHashID> </GetPersonWebSafe> </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> <GetPersonWebSafeResponse xmlns="http://schema.veetro.com"> <GetPersonWebSafeResult> <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> </GetPersonWebSafeResult> </GetPersonWebSafeResponse> </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/GetPersonWebSafe?EntityHashID=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"?> <Person xmlns="http://schema.veetro.com"> <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>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/GetPersonWebSafe HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length EntityHashID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <Person xmlns="http://schema.veetro.com"> <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>