Back to Service

Method Details for GetGroupsRaw.

Get a list of groups and values associated with them

Parameters

  • siteCode String Unique identification for your TimeLog account
  • apiID String The API ID
  • apiPassword String The API password
  • groupID Integer ID of specific group. Set to 0 to get all groups
  • typeID Integer Location of the group. Set to 0 for all types; 1 for Customers; 2 for Contacts; 3 for Opportunity
  • status Integer Set to 0 for inactive groups; 1 for active groups; -1 to get all groups

Returns

A list of group in standard XML document

Result Example

<?xml version="1.0" encoding="utf-8"?>
<tlp:Groups xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4">
  <tlp:Group ID="1">
    <tlp:Name>Is Friend With CEO</tlp:Name>
    <tlp:Type>1</tlp:Type>
    <tlp:InputType>1</tlp:InputType>
    <tlp:IsActive>1</tlp:IsActive>
    <tlp:Values>
      <tlp:Value xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4" ID="1">
        <tlp:Name>Very good friend</tlp:Name>
        <tlp:IsDefault>0</tlp:IsDefault>
      </tlp:Value>
      <tlp:Value xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4" ID="2">
        <tlp:Name>Acquaintance</tlp:Name>
        <tlp:IsDefault>1</tlp:IsDefault>
      </tlp:Value>
    </tlp:Values>
  </tlp:Group>
  <tlp:Group ID="2">
    <tlp:Name>CEO Name</tlp:Name>
    <tlp:Type>1</tlp:Type>
    <tlp:InputType>2</tlp:InputType>
    <tlp:IsActive>1</tlp:IsActive>
  </tlp:Group>
  <tlp:Group ID="3">
    <tlp:Name>Knows How To Play Golf</tlp:Name>
    <tlp:Type>2</tlp:Type>
    <tlp:InputType>1</tlp:InputType>
    <tlp:IsActive>1</tlp:IsActive>
    <tlp:Values>
      <tlp:Value xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4" ID="3">
        <tlp:Name>Yes</tlp:Name>
        <tlp:IsDefault>1</tlp:IsDefault>
      </tlp:Value>
      <tlp:Value xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4" ID="4">
        <tlp:Name>No</tlp:Name>
        <tlp:IsDefault>0</tlp:IsDefault>
      </tlp:Value>
    </tlp:Values>
  </tlp:Group>
</tlp:Groups>

Result Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4"
            targetNamespace="http://www.timelog.com/XML/Schema/tlp/v4_4"
            elementFormDefault="qualified"
            attributeFormDefault="unqualified">
  <xsd:element name="Groups" >
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="Group" type="tlp:GroupsRaw_Type" minOccurs="0" maxOccurs="unbounded" />
      </xsd:sequence>
    </xsd:complexType>
    <xsd:key name="Event_Key">
      <xsd:selector xpath=".//tlp:Group" />
      <xsd:field xpath="@ID" />
    </xsd:key>
  </xsd:element>

  <xsd:complexType name="GroupsRaw_Type">
    <xsd:sequence>
      <xsd:element name="Name" type="xsd:string" />
      <xsd:element name="Type" type="xsd:integer" />
      <xsd:element name="InputType" type="xsd:integer" />
      <xsd:element name="IsActive" type="xsd:integer" />
      <xsd:element minOccurs="0" name="Values">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element maxOccurs="unbounded" name="Value">
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="Name" type="xsd:string" />
                  <xsd:element name="IsDefault" type="xsd:boolean" />
                </xsd:sequence>
                <xsd:attribute name="ID" type="xsd:integer" use="required" />
              </xsd:complexType>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
    <xsd:attribute name="ID" type="xsd:integer" use="required" />
  </xsd:complexType>

</xsd:schema>

Download the XSD