GetContactByGUID

CRM service 1.4: Returns one contact person, identified by its GUID, optionally with its custom fields and external keys.


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/GetContactByGUID`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes

How it works

Reads a single contact by the contact's GUID. The contact comes back as Return[0] of the Response envelope. Set loadCustomFields / loadExternalKeys to also fill the contact's custom fields and its external-system keys; otherwise those lists are empty and IsCustomFieldsLoaded / IsExternalKeysLoaded are false. An unknown GUID is an ERROR, not an empty result: ResponseState Error, ErrorCode 40001 and a data-layer message. Inactive contacts are returned like active ones.

Parameters

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

guidguid

Required

GUID of the contact.

loadCustomFieldsboolean

Optional. Default false. true = fill CustomFields and set IsCustomFieldsLoaded.

loadExternalKeysboolean

Optional. Default false. true = fill ExternalKeys and set IsExternalKeysLoaded.

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

<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:GetContactByGUID>
      <crm:guid>{guid}</crm:guid>
      <crm:loadCustomFields>false</crm:loadCustomFields>
      <crm:loadExternalKeys>false</crm:loadExternalKeys>
      <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:GetContactByGUID>
  </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/GetContactByGUID"' \
  --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/GetContactByGUID"'

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:GetContactByGUID>
      <crm:guid>{guid}</crm:guid>
      <crm:loadCustomFields>false</crm:loadCustomFields>
      <crm:loadExternalKeys>false</crm:loadExternalKeys>
      <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:GetContactByGUID>
  </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.

ReturnContact[]

Response<Contact>: Return holds exactly one Contact. No 'Successfully called' message is added; Messages holds only the call duration. Never empty on success: an unknown GUID is ResponseState Error.

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>
    <GetContactByGUIDResponse xmlns="http://api.timelog.com/services/crm/1_4">
      <GetContactByGUIDResult 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>false</a:IsReturnPaged>
        <a:TotalPageCount>0</a:TotalPageCount>
      </GetContactByGUIDResult>
    </GetContactByGUIDResponse>
  </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 'Unable to retrieve result from … GUID{guid}'	No contact has this GUID.	Check the GUID; treat this message as 'not found'.

Was this page helpful?