Veetro Web Service Methods Web Service

Veetro Web Service Methods

Click here for a complete list of operations.

SetPerson

[Permission: Any Authenticated, Credentials: Contacts.People]
Saves a Person. If EntityID = 0, a new Person will be created. Returns a Saved copy of the Person including the newly created EntityID. Non-employee users can only save their own profile and previous/existing settings are overridden upon save. New contact creation is also not permitted by non-employee users.
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.

Test

The test form is only available for requests from the local machine.

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/SetPerson"

<?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>
    <SetPerson 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>
    </SetPerson>
  </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>
    <SetPersonResponse xmlns="http://schema.veetro.com">
      <SetPersonResult>
        <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>
      </SetPersonResult>
    </SetPersonResponse>
  </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>
    <SetPerson 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>
    </SetPerson>
  </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>
    <SetPersonResponse xmlns="http://schema.veetro.com">
      <SetPersonResult>
        <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>
      </SetPersonResult>
    </SetPersonResponse>
  </soap12:Body>
</soap12:Envelope>