GetContactsByCustomerPaged

CRM service 1.4: Returns the active contacts of one customer, a page at a time, sorted by last name then first name.


Service	CRM 1.4
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc`
SOAPAction	`http://api.timelog.com/services/crm/1_4/ICRMService/GetContactsByCustomerPaged`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes
Paging	Yes, up to 500 per page

How it works

Lists the contact persons of the customer identified by customerId. Only ACTIVE contacts are returned. The full list is loaded and then sliced in memory: page is 1-based, pageSize is capped at 500, and TotalPageCount in the envelope tells how many pages exist. Set loadCustomFields / loadExternalKeys to fill each contact's custom fields and external keys.

Parameters

Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.

customerIdguid

Required

GUID of the customer.

loadCustomFieldsboolean

Optional. Default false. true = fill each contact's CustomFields.

loadExternalKeysboolean

Optional. Default false. true = fill each contact's ExternalKeys.

pageinteger

Required

1-based page number. Values <= 0 behave like 1.

pageSizeinteger

Required

Contacts per page; values above 500 are lowered to 500. Must be > 0.

tokenSecurityToken

Required

The token from GetToken: Initials, Expires and Hash, sent back unchanged.

Request

POST /{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://api.timelog.com/services/crm/1_4/ICRMService/GetContactsByCustomerPaged"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:crm="http://api.timelog.com/services/crm/1_4"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <crm:GetContactsByCustomerPaged>
      <crm:customerId>{customerId}</crm:customerId>
      <crm:loadCustomFields>false</crm:loadCustomFields>
      <crm:loadExternalKeys>false</crm:loadExternalKeys>
      <crm:page>1</crm:page>
      <crm:pageSize>100</crm:pageSize>
      <crm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </crm:token>
    </crm:GetContactsByCustomerPaged>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://api.timelog.com/services/crm/1_4/ICRMService/GetContactsByCustomerPaged"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc"
SOAP_ACTION = '"http://api.timelog.com/services/crm/1_4/ICRMService/GetContactsByCustomerPaged"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:crm="http://api.timelog.com/services/crm/1_4"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <crm:GetContactsByCustomerPaged>
      <crm:customerId>{customerId}</crm:customerId>
      <crm:loadCustomFields>false</crm:loadCustomFields>
      <crm:loadExternalKeys>false</crm:loadExternalKeys>
      <crm:page>1</crm:page>
      <crm:pageSize>100</crm:pageSize>
      <crm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </crm:token>
    </crm:GetContactsByCustomerPaged>
  </soapenv:Body>
</soapenv:Envelope>"""

response = requests.post(
    URL,
    data=envelope.encode("utf-8"),
    headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
    timeout=60,
)
result = parse_result(response)  # see "Responses and errors"

Replace every {…} placeholder with your own value.

Response

The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.

ResponseStatestring

Required

Success, Invalid or Error.

ErrorCodeinteger

0 on success, otherwise the error code. See Errors.

TotalPageCountinteger

Number of pages for the whole result with your pageSize. Keep calling with page + 1 until you have read them all.

ReturnContact[]

Response<Contact>: Return = one page of contacts; IsReturnPaged = true; TotalPageCount = pages for the whole customer. ResponseState Success with an empty Return and TotalPageCount 0 when the customer has no active contacts.

Example response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetContactsByCustomerPagedResponse xmlns="http://api.timelog.com/services/crm/1_4">
      <GetContactsByCustomerPagedResult xmlns:a="http://api.timelog.com"
                                        xmlns:b="http://api.timelog.com/services/crm/1_4"
                                        xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Contact>
            <a:Action>Original</a:Action>
            <a:IsCustomFieldsLoaded>false</a:IsCustomFieldsLoaded>
            <a:CustomFields i:nil="true"/>
            <a:IsExternalKeysLoaded>false</a:IsExternalKeysLoaded>
            <a:ExternalKeys i:nil="true"/>
            <b:GUID>3f2504e0-4f89-41d3-9a0c-305000000001</b:GUID>
            <b:Firstname>Example</b:Firstname>
            <b:Lastname>Example</b:Lastname>
            <b:Email>info@example.com</b:Email>
            <b:Mobile>+45 00 00 00 00</b:Mobile>
            <b:Phone>+45 00 00 00 00</b:Phone>
            <b:Fax>+45 00 00 00 00</b:Fax>
            <b:Address>
              <a:Address1>Example</a:Address1>
              <a:Address2>Example</a:Address2>
              <a:Address3>Example</a:Address3>
              <a:ZipCode>1000</a:ZipCode>
              <a:City>Copenhagen</a:City>
              <a:State>Example</a:State>
              <a:Country>DK</a:Country>
            </b:Address>
            <b:Comment>Example</b:Comment>
            <b:Title>Example</b:Title>
            <b:CustomerGUID>3f2504e0-4f89-41d3-9a0c-305000000002</b:CustomerGUID>
            <b:ContactID>1001</b:ContactID>
            <b:DefaultInvoiceSettingContactID>1001</b:DefaultInvoiceSettingContactID>
            <b:IsActive>true</b:IsActive>
            <b:ProfessionalTitle1>Example</b:ProfessionalTitle1>
            <b:ProfessionalTitle2>Example</b:ProfessionalTitle2>
            <b:Details>
              <b:Owner>
                <a:ID>1001</a:ID>
                <a:Initials>ABC</a:Initials>
                <a:FullName>Example full</a:FullName>
              </b:Owner>
              <b:CustomerHeader>
                <b:ID>1001</b:ID>
                <b:Name>Example </b:Name>
                <b:No>1001</b:No>
                <b:GUID>3f2504e0-4f89-41d3-9a0c-305000000003</b:GUID>
              </b:CustomerHeader>
            </b:Details>
          </b:Contact>
        </a:Return>
        <a:ReturnTypeDescription>Contact</a:ReturnTypeDescription>
        <a:Request>…</a:Request>
        <a:ResponseState>Success</a:ResponseState>
        <a:Messages>
          <a:APIMessage>
            <a:Message>Duration of call was 0,0421337 sec.</a:Message>
            <a:Severity>Message</a:Severity>
            <a:ErrorCode>0</a:ErrorCode>
          </a:APIMessage>
        </a:Messages>
        <a:ErrorCode>0</a:ErrorCode>
        <a:IsReturnPaged>true</a:IsReturnPaged>
        <a:TotalPageCount>1</a:TotalPageCount>
      </GetContactsByCustomerPagedResult>
    </GetContactsByCustomerPagedResponse>
  </s:Body>
</s:Envelope>

Illustrative example: built from the service description (WSDL) in the same format as a real response, with made-up values. The Request block is shortened.

Errors

All errors come back with HTTP 200: check ResponseState, ErrorCode and Messages. The errors every operation can return (expired or invalid token, API not enabled, HTTPS required, general errors) are listed once in Responses and errors.

Errors specific to this operation:

ResponseState	ErrorCode	Message	What it means	What to do
Error	40001	Error during call on TimeLog.API, Message 'Identifier Customer GUID with value {guid}, is unknown in TLP'	customerId is not an existing customer.	Check the customer GUID.
Error	40001	Error during call on TimeLog.API, Message 'Unable to retrieve result from … with GUID{guid}'	The customer GUID does not exist.	Check the customer GUID.

Was this page helpful?