Back to Service

Method Details for GetSupportContractRaw.

Gets a list of support contracts

Parameters

  • siteCode String Unique identification for your TimeLog account
  • apiID String The API ID
  • apiPassword String The API password
  • supportContractID Integer ID of specific support contract. Set to 0 to get all
  • employeeID Integer ID of specific Employee. Set to 0 to get all
  • customerID Integer ID of an Customer. Set to 0 to get
  • supportContractTypeID Integer ID of an support contract type. Set to 0 to get all. (1 = Time and Material; 2 = Multiple Case Contract; 3 = Subscription)

Returns

A list of support contract objects in XML format

Result Example

<?xml version="1.0" encoding="utf-8"?>
<tlp:SupportContracts xmlns:tlp="http://www.timelog.com/XML/Schema/tlp/v4_4">
  <tlp:SupportContract ID="403">
    <tlp:No>A08.0186</tlp:No>
    <tlp:Header>SLA (Support Requests)</tlp:Header>
    <tlp:Comment>This contract covers support requests only. Service requests and Change requests must use the "Outside Contract" option.</tlp:Comment>
    <tlp:Active>0</tlp:Active>
    <tlp:ContractTypeID>3</tlp:ContractTypeID>
    <tlp:ContractTypeName>Subscription</tlp:ContractTypeName>
    <tlp:MultipleCaseRegAmount>0</tlp:MultipleCaseRegAmount>
    <tlp:MultipleCaseInvDate>2009-01-01T00:00:00</tlp:MultipleCaseInvDate>
    <tlp:SubscriptionStartDate>2008-02-21T00:00:00</tlp:SubscriptionStartDate>
    <tlp:SubscriptionBillingPeriodID>1</tlp:SubscriptionBillingPeriodID>
    <tlp:SubscriptionBillingPeriodName>Annual</tlp:SubscriptionBillingPeriodName>
    <tlp:SubscriptionRegAmount>0</tlp:SubscriptionRegAmount>
    <tlp:SubscriptionInvDate>2009-01-01T00:00:00</tlp:SubscriptionInvDate>
    <tlp:EmployeeID>48</tlp:EmployeeID>
    <tlp:EmployeeInitials>TSG</tlp:EmployeeInitials>
    <tlp:EmployeeFullName>Thomas Gudmandsen</tlp:EmployeeFullName>
    <tlp:CustomerID>3672</tlp:CustomerID>
    <tlp:CustomerName>Best Practice Inc.</tlp:CustomerName>
    <tlp:CustomerNo>07.2990</tlp:CustomerNo>
  </tlp:SupportContract>
  <tlp:SupportContract ID="404">
    <tlp:No>A08.0187</tlp:No>
    <tlp:Header>SLA (Support Requests)</tlp:Header>
    <tlp:Comment>This contract covers support requests only. Service requests and Change requests must use the "Outside Contract" option.</tlp:Comment>
    <tlp:Active>0</tlp:Active>
    <tlp:ContractTypeID>3</tlp:ContractTypeID>
    <tlp:ContractTypeName>Subscription</tlp:ContractTypeName>
    <tlp:MultipleCaseRegAmount>0</tlp:MultipleCaseRegAmount>
    <tlp:MultipleCaseInvDate>2009-01-01T00:00:00</tlp:MultipleCaseInvDate>
    <tlp:SubscriptionStartDate>2008-02-27T00:00:00</tlp:SubscriptionStartDate>
    <tlp:SubscriptionBillingPeriodID>1</tlp:SubscriptionBillingPeriodID>
    <tlp:SubscriptionBillingPeriodName>Annual</tlp:SubscriptionBillingPeriodName>
    <tlp:SubscriptionRegAmount>0</tlp:SubscriptionRegAmount>
    <tlp:SubscriptionInvDate>2009-01-01T00:00:00</tlp:SubscriptionInvDate>
    <tlp:EmployeeID>48</tlp:EmployeeID>
    <tlp:EmployeeInitials>TSG</tlp:EmployeeInitials>
    <tlp:EmployeeFullName>Thomas Gudmandsen</tlp:EmployeeFullName>
    <tlp:CustomerID>3833</tlp:CustomerID>
    <tlp:CustomerName>Mascendi SpA</tlp:CustomerName>
    <tlp:CustomerNo>07.3151</tlp:CustomerNo>
  </tlp:SupportContract>
</tlp:SupportContracts>

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="SupportContracts" >
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="SupportContract" type="tlp:SupportContractRaw_Type" minOccurs="0" maxOccurs="unbounded" />
      </xsd:sequence>
    </xsd:complexType>
    <xsd:key name="SupportCase_Key">
      <xsd:selector xpath=".//tlp:SupportContract" />
      <xsd:field xpath="@ID" />
    </xsd:key>
  </xsd:element>

  <xsd:complexType name="SupportContractRaw_Type">
    <xsd:sequence>
      <xsd:element name="No" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="Header" type="xsd:string" />
      <xsd:element name="Comment" type="xsd:string" />
      <xsd:element name="Active" type="xsd:byte" />
      <xsd:element name="ContractTypeID" type="xsd:positiveInteger" />
      <xsd:element name="ContractTypeName" type="xsd:string" />
      <xsd:element name="TimeMaterialHourlyRate" type="xsd:decimal" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="TimeMaterialMinimumMinutes" type="xsd:positiveInteger" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="MultipleCaseNumberOfCases" type="xsd:positiveInteger" minOccurs="0" maxOccurs="1" />
      <xsd:element name="MultipleCaseRegAmount" type="xsd:decimal" minOccurs="0" maxOccurs="1" />
      <xsd:element name="MultipleCaseInvAmount" type="xsd:decimal" minOccurs="0" maxOccurs="1" />
      <xsd:element name="MultipleCaseInvDate" type="xsd:dateTime" minOccurs="0" maxOccurs="1" />
      <xsd:element name="SubscriptionStartDate" type="xsd:dateTime" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="SubscriptionBillingPeriodID" type="xsd:positiveInteger" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="SubscriptionBillingPeriodName" type="xsd:string" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="SubscriptionRegAmount" type="xsd:decimal" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="SubscriptionInvAmount" type="xsd:decimal" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="SubscriptionInvDate" type="xsd:dateTime" minOccurs="0" maxOccurs="1"  />
      <xsd:element name="EmployeeID" type="xsd:positiveInteger" />
      <xsd:element name="EmployeeInitials" type="xsd:string" />
      <xsd:element name="EmployeeFullName" type="xsd:string" />
      <xsd:element name="CustomerID" type="xsd:positiveInteger" />
      <xsd:element name="CustomerName" type="xsd:string" />
      <xsd:element name="CustomerNo" type="xsd:string" minOccurs="0" maxOccurs="1"  />
    </xsd:sequence>
    <xsd:attribute name="ID" type="xsd:positiveInteger" use="required" />
  </xsd:complexType>
</xsd:schema>

Download the XSD