Veetro Web Service Methods


Click here for a complete list of operations.

GetEntityShared

[Permission: NULL]
Returns a paged set of contacts shared with certain person, return contacts only contain EntityID, Name, Flags.

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

<?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>
    <GetEntityShared xmlns="http://schema.veetro.com">
      <e>
        <SharedEntityID>int</SharedEntityID>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <Flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</Flags>
        <Keywords>string</Keywords>
        <IncludeAssociatedCompany>boolean</IncludeAssociatedCompany>
      </e>
    </GetEntityShared>
  </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>
    <GetEntitySharedResponse xmlns="http://schema.veetro.com">
      <GetEntitySharedResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <SahredEntityResult>
            <EntityID>int</EntityID>
            <Name>string</Name>
            <Flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</Flags>
          </SahredEntityResult>
          <SahredEntityResult>
            <EntityID>int</EntityID>
            <Name>string</Name>
            <Flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</Flags>
          </SahredEntityResult>
        </Results>
      </GetEntitySharedResult>
    </GetEntitySharedResponse>
  </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>
    <GetEntityShared xmlns="http://schema.veetro.com">
      <e>
        <SharedEntityID>int</SharedEntityID>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <Flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</Flags>
        <Keywords>string</Keywords>
        <IncludeAssociatedCompany>boolean</IncludeAssociatedCompany>
      </e>
    </GetEntityShared>
  </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>
    <GetEntitySharedResponse xmlns="http://schema.veetro.com">
      <GetEntitySharedResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <SahredEntityResult>
            <EntityID>int</EntityID>
            <Name>string</Name>
            <Flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</Flags>
          </SahredEntityResult>
          <SahredEntityResult>
            <EntityID>int</EntityID>
            <Name>string</Name>
            <Flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</Flags>
          </SahredEntityResult>
        </Results>
      </GetEntitySharedResult>
    </GetEntitySharedResponse>
  </soap12:Body>
</soap12:Envelope>