Veetro Web Service Methods
Click here for a complete list of operations.
GetUserGroups
[Permission: Employee]
Returns all Employee UserGroup's in the Database.
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/GetUserGroups" <?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> <GetUserGroups xmlns="http://schema.veetro.com" /> </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> <GetUserGroupsResponse xmlns="http://schema.veetro.com"> <GetUserGroupsResult> <UserGroup> <UserGroupID>int</UserGroupID> <Name>string</Name> <Type>Employee or Customer</Type> <DateLastModified>dateTime</DateLastModified> <DefaultCredentials> <Credential xsi:nil="true" /> <Credential xsi:nil="true" /> </DefaultCredentials> <CredentialsData>string</CredentialsData> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> </UserGroup> <UserGroup> <UserGroupID>int</UserGroupID> <Name>string</Name> <Type>Employee or Customer</Type> <DateLastModified>dateTime</DateLastModified> <DefaultCredentials> <Credential xsi:nil="true" /> <Credential xsi:nil="true" /> </DefaultCredentials> <CredentialsData>string</CredentialsData> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> </UserGroup> </GetUserGroupsResult> </GetUserGroupsResponse> </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> <GetUserGroups xmlns="http://schema.veetro.com" /> </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> <GetUserGroupsResponse xmlns="http://schema.veetro.com"> <GetUserGroupsResult> <UserGroup> <UserGroupID>int</UserGroupID> <Name>string</Name> <Type>Employee or Customer</Type> <DateLastModified>dateTime</DateLastModified> <DefaultCredentials> <Credential xsi:nil="true" /> <Credential xsi:nil="true" /> </DefaultCredentials> <CredentialsData>string</CredentialsData> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> </UserGroup> <UserGroup> <UserGroupID>int</UserGroupID> <Name>string</Name> <Type>Employee or Customer</Type> <DateLastModified>dateTime</DateLastModified> <DefaultCredentials> <Credential xsi:nil="true" /> <Credential xsi:nil="true" /> </DefaultCredentials> <CredentialsData>string</CredentialsData> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> </UserGroup> </GetUserGroupsResult> </GetUserGroupsResponse> </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/GetUserGroups? 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"?> <ArrayOfUserGroup xmlns="http://schema.veetro.com"> <UserGroup> <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> </UserGroup> <UserGroup> <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> </UserGroup> </ArrayOfUserGroup>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/GetUserGroups HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfUserGroup xmlns="http://schema.veetro.com"> <UserGroup> <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> </UserGroup> <UserGroup> <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> </UserGroup> </ArrayOfUserGroup>