Veetro Web Service Methods


Click here for a complete list of operations.

SetUserGroup

[Permission: Contacts.Employees.ModifyFull]
Creates or updates a UserGroup

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

<?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>
    <SetUserGroup xmlns="http://schema.veetro.com">
      <group>
        <UserGroupID>int</UserGroupID>
        <Name>string</Name>
        <Type>Employee or Customer</Type>
        <DateLastModified>dateTime</DateLastModified>
        <DefaultCredentials>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
        </DefaultCredentials>
        <CredentialsData>string</CredentialsData>
        <Delete>boolean</Delete>
        <RemoveParentLinks>boolean</RemoveParentLinks>
      </group>
    </SetUserGroup>
  </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>
    <SetUserGroupResponse xmlns="http://schema.veetro.com">
      <SetUserGroupResult>
        <UserGroupID>int</UserGroupID>
        <Name>string</Name>
        <Type>Employee or Customer</Type>
        <DateLastModified>dateTime</DateLastModified>
        <DefaultCredentials>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
        </DefaultCredentials>
        <CredentialsData>string</CredentialsData>
        <Delete>boolean</Delete>
        <RemoveParentLinks>boolean</RemoveParentLinks>
      </SetUserGroupResult>
    </SetUserGroupResponse>
  </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>
    <SetUserGroup xmlns="http://schema.veetro.com">
      <group>
        <UserGroupID>int</UserGroupID>
        <Name>string</Name>
        <Type>Employee or Customer</Type>
        <DateLastModified>dateTime</DateLastModified>
        <DefaultCredentials>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
        </DefaultCredentials>
        <CredentialsData>string</CredentialsData>
        <Delete>boolean</Delete>
        <RemoveParentLinks>boolean</RemoveParentLinks>
      </group>
    </SetUserGroup>
  </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>
    <SetUserGroupResponse xmlns="http://schema.veetro.com">
      <SetUserGroupResult>
        <UserGroupID>int</UserGroupID>
        <Name>string</Name>
        <Type>Employee or Customer</Type>
        <DateLastModified>dateTime</DateLastModified>
        <DefaultCredentials>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
          <Credential>
            <Moniker>string</Moniker>
          </Credential>
        </DefaultCredentials>
        <CredentialsData>string</CredentialsData>
        <Delete>boolean</Delete>
        <RemoveParentLinks>boolean</RemoveParentLinks>
      </SetUserGroupResult>
    </SetUserGroupResponse>
  </soap12:Body>
</soap12:Envelope>