TimAPI

Getting Started

Introduction

TimAPI is a WCF/SOAP webservice to integrate with external applications. TimAPI can only be used with the credentials of a valid Tim user. Standard responses of the webservice methods are coded in JSON. Please submit a request to Softmakers to configure the webservice for SOAP XML if needed.

Go to https://.timsaas.com/timapi.service/common.svc to check the TimAPI with a browser. For a specification of the active methods please use https://.timsaas.com/timapi.service/common.svc/help.

Terug naar boven

Authentication

Authentication with valid Tim user credentials is mandatory to get access to the information in the Tim database. The users of the TimWeb client define the accesability of the information on a rol based model. Tim users can be a member of one or many roles. The TimAPI follows this definition based on the supplied credentials. So by using ‘wrong’ credentials the TimAPI methods will deliver less data.

POST yourdomain.timsaas.com/TimApi.service/Common.svc/Login

The credentials are supplied in the following JSON header:

{"userName":"diederik", "passWord":"slotsom", "profile":"TimWeb"}

 
The response of this method will be a STRING value holding the token that must be provided as a header with all the methods in the following chapter.

Terug naar boven

Diagnostics

For diagnostic or other purposes we provide a method to determine if the TimAPI is up and running. You can use a simple browser to run this method.

GET yourdomain.timsaas.com/TimApi.service/Common.svc/Ping

The response of this method is the following JSON string:

{
"PingResult": "Good afternoon,\\n\\nYou are connected to the TimApi.Service.Common webservice running at http://008-tst.softmakers.local/TimApi.Service/Common.svc.\\nThe current time is 10/21/2016 12:50:27 PM.\\n\\nHope you have a great day!"
}

Terug naar boven

Methods

View an object

GET yourdomain.timsaas.com/TimApi.service/Common.svc/GetObject?docType=[type]?docNr=[nr]

Description

Each object in the Tim database is identifyable by the combination [type] and [nr]. The response of this function will show all properties, labels, keywords and TimLinks of the referenced object instance. Reuse GetObject with the BType and BNr properties of a link node to view the information of the linked object. If there is information within the link you can view this information with the GetLinkSpec function. Use GetMetaData to find descriptions of the properties.

Parameters

Name Description
docType INT – Object types in Tim are identified by a unique ID.

  • 1 : Bedrijf
  • 2 : Persoon
  • 3 : Aanhangsel
  • 6 : Agenda
  • 8 : Workflow
  • 7 : Notitie
  • 5 : Internet
  • 4 : Contact
  • 11: Verkoophistorie
  • 13: Service
  • 17: Project
  • 18: Media
  • 19: Machine
  • 21: Software
  • 26: Produkt
  • 27: Contract
  • 31: Voertuig
  • 32: TeleMail
  • 33: Dossier
  • 34: Afdeling
  • 35: Tijdregistratie
  • 40: Verkoop
  • 41: Foto
  • 43: Werkplek
  • 49: Merk
  • 55: Lidmaatschap
  • 56: Bijdrage
  • 57: Boeken
  • 70: Procedure
  • 71: Complex
  • 72: Eenheid
  • 73: Budget
  • 74: Social Media
  • 78: Opdracht
docNr INT – The primary key of the object instance

 

Response

{
"Properties": {
"BedrijfNr": 112,
"Naam": "Euro City Hopper",
"Mdw": "II ",
"ReisKm": 50,
"ReisTijd": "1900-01-01T02:15:00",
"Telefax": "+3110 4567779",
"Telefoon": "+3110 4566387",
"TelefoonV": "",
"Zoekcode": "EUROCITY",
"SoortNr": 2,
"BrancheCd": "",
"KvkNr": "",
"AantWrkn": 4,
"Bron": "",
"FkBdrNr": 0,
"VsNr": 0,
"InDatum": "2006-02-27T12:14:00",
"InMdw": "SAR",
"MutDatum": "2016-10-20T17:28:39.267",
"MutCount": 4,
"MutMdw": "TT ",
"Timestamp": "AAAAAACbfpk=",
"VsMdw": " ",
"VsCount": 0,
"SecId": "AAAAAQ==",
"SecMut": "AAAAAQ==",
"MailAdres": "info@eurocity.net",
"ObjDatum": "2008-11-21T10:00:00",
"AttNr": 0,
"SecDel": "AAAAAQ==",
"ExtRef": "",
"SecRub": "AAAAAQ==",
"Grootte": 2,
"StatusNr": 1,
"Rechtsvorm": 41,
"Opgericht": "2016-05-01T00:00:00",
"NoMail": false,
"ExtInfo": null,
"NoExInfo": false,
"SubCat": 1,
"DubCheck": 0,
"ConpersNr": 0,
"SecVld": "AAAAAQ==",
"BrancheNr": 0
},
"Extra": null,
"KeyWords": [
{
"SleutelNr": 751,
"Sleutel_": "reizen",
"SlCount": 1,
"InMdw": "TT ",
"InDatum": "2016-10-20T17:00:16.673",
"MutMdw": " ",
"MutCount": 0,
"MutDatum": "1900-01-01T00:00:00",
"Timestamp": "AAAAAACbffs="
},
{
"SleutelNr": 71,
"Sleutel_": "tim",
"SlCount": 39,
"InMdw": "WT ",
"InDatum": "2000-04-14T14:09:12.56",
"MutMdw": "TT ",
"MutCount": 1,
"MutDatum": "2016-11-01T17:17:25.073",
"Timestamp": "AAAAAACcLJg="
}
],
"Labels": [
{
"Code": "02",
"Items": null,
"Omschrijf": "Tim",
"IsAssignedToDocument": true,
"IsModified": false,
"MailType": 0,
"MailExtra": 0,
"ComType": 0,
"ComNr": 0
},
{
"Code": "0207",
"Items": null,
"Omschrijf": "klant",
"IsAssignedToDocument": true,
"IsModified": false,
"MailType": 0,
"MailExtra": 0,
"ComType": 0,
"ComNr": 0
},
{
"Code": "03",
"Items": null,
"Omschrijf": "Beurzen",
"IsAssignedToDocument": true,
"IsModified": false,
"MailType": 0,
"MailExtra": 0,
"ComType": 0,
"ComNr": 0
},
{
"Code": "0301",
"Items": null,
"Omschrijf": "Opening BCN Nieuwegein",
"IsAssignedToDocument": true,
"IsModified": false,
"MailType": 0,
"MailExtra": 0,
"ComType": 0,
"ComNr": 0
}
],
"TimLinks": [
{
"LinkNr": 146652,
"ANr": 112,
"AType": 1,
"BNr": 136,
"BType": 4,
"LinkType": 13,
"Timestamp": "AAAAAACAxDo=",
"InMdw": "SAR",
"InDatum": "2006-03-15T00:00:00"
},
{
"LinkNr": 146654,
"ANr": 112,
"AType": 1,
"BNr": 137,
"BType": 4,
"LinkType": 13,
"Timestamp": "AAAAAACAxDw=",
"InMdw": "SAR",
"InDatum": "2006-03-15T00:00:00"
},
{
"LinkNr": 146656,
"ANr": 112,
"AType": 1,
"BNr": 138,
"BType": 4,
"LinkType": 14,
"Timestamp": "AAAAAACAxD4=",
"InMdw": "SAR",
"InDatum": "2006-03-15T00:00:00"
},
{
"LinkNr": 146442,
"ANr": 112,
"AType": 1,
"BNr": 139,
"BType": 2,
"LinkType": 0,
"Timestamp": "AAAAAACAwCI=",
"InMdw": "SAR",
"InDatum": "2006-02-28T00:00:00"
},
{
"LinkNr": 146441,
"ANr": 112,
"AType": 1,
"BNr": 140,
"BType": 2,
"LinkType": 0,
"Timestamp": "AAAAAACAwCA=",
"InMdw": "SAR",
"InDatum": "2006-02-28T00:00:00"
},
{
"LinkNr": 146440,
"ANr": 112,
"AType": 1,
"BNr": 141,
"BType": 2,
"LinkType": 0,
"Timestamp": "AAAAAACAwB4=",
"InMdw": "SAR",
"InDatum": "2006-02-28T00:00:00"
},
{
"LinkNr": 171573,
"ANr": 112,
"AType": 1,
"BNr": 2542,
"BType": 4,
"LinkType": 0,
"Timestamp": "AAAAAACbwNc=",
"InMdw": "",
"InDatum": "1900-01-01T00:00:00"
},
{
"LinkNr": 146680,
"ANr": 112,
"AType": 1,
"BNr": 9160,
"BType": 8,
"LinkType": 0,
"Timestamp": "AAAAAACA0a8=",
"InMdw": "IVM",
"InDatum": "2006-03-16T00:00:00"
}
],
"RelationalData": {
"Addresses": {
"vestigingsadres": {
"AdresNr": 112,
"Naam2": "",
"Adres_": "Industrieweg",
"Huisnr": "38",
"Extra": "",
"Plaats": "ZESTIENHOEVER",
"Postcode": "2600 EL",
"LandNr": 2,
"InMdw": "SAR",
"InDatum": "2006-02-27T12:16:00",
"MutDatum": "1900-01-01T00:00:00",
"MutCount": 0,
"MutMdw": " ",
"Timestamp": "AAAAAABEic0=",
"Longitude": 0,
"Latitude": 0,
"Gemeente": "",
"Provincie": ""
},
"postadres": {
"AdresNr": 1499,
"Naam2": "",
"Adres_": "",
"Huisnr": "",
"Extra": "",
"Plaats": "",
"Postcode": "",
"LandNr": 2,
"InMdw": "TIM",
"InDatum": "2016-09-02T11:16:14.5",
"MutDatum": "1900-01-01T00:00:00",
"MutCount": 0,
"MutMdw": " ",
"Timestamp": "AAAAAACXo5w=",
"Longitude": 0,
"Latitude": 0,
"Gemeente": "",
"Provincie": ""
},
"factuuradres": {
"AdresNr": 1837,
"Naam2": "",
"Adres_": "",
"Huisnr": "",
"Extra": "",
"Plaats": "",
"Postcode": "",
"LandNr": 2,
"InMdw": "TIM",
"InDatum": "2016-09-02T11:16:14.713",
"MutDatum": "1900-01-01T00:00:00",
"MutCount": 0,
"MutMdw": " ",
"Timestamp": "AAAAAACXpO8=",
"Longitude": 0,
"Latitude": 0,
"Gemeente": "",
"Provincie": ""
},
"leveradres": {
"AdresNr": 2281,
"Naam2": "Gebouw D",
"Adres_": "Paalbergweg",
"Huisnr": "234",
"Extra": "",
"Plaats": "KENNEMERLAND",
"Postcode": "3000 KK",
"LandNr": 2,
"InMdw": "TIM",
"InDatum": "2016-09-02T11:16:15.247",
"MutDatum": "2016-10-20T17:28:39.19",
"MutCount": 1,
"MutMdw": "TT ",
"Timestamp": "AAAAAACbfpg=",
"Longitude": 0,
"Latitude": 0,
"Gemeente": "",
"Provincie": ""
}
}
}
}
}

Terug naar boven

View a TimLink specification

GET yourdomain.timsaas.com/TimApi.service/Common.svc/GetLinkSpec?id=[linknumber]

Description

Object instances can be associated with by using TimLinks. Many Timlinks have special properties belonging to the combination of the 2 linked object instances. The function GetObject returns a response with [LinkNr] properties for each TimLink. Use this value as input for this method to view the properties of that TimLink.
 

Parameters

Name Description
linkNr STRING – id of TimLink (LinkNr)

 

Response

{
"Properties": [
{
"Xprimair": false,
"XTemplate": null,
"LinkNr": 146442,
"Afdeling": "",
"Functie": "",
"DirectTel": "",
"MailAdres": "",
"Aanvang": null,
"Einde": null,
"Primair": false,
"Notitie": "",
"InDatum": "2006-02-28T00:00:00",
"InMdw": "SAR",
"MutCount": 0,
"MutDatum": null,
"MutMdw": " ",
"Timestamp": "AAAAAABFQOQ=",
"Extern": false,
"RolNr": 0,
"Id": "",
"PrsNr": 0,
"Derden": false,
"MobielTel": ""
}
],
"Extra": null,
"KeyWords": null,
"Labels": null,
"TimLinks": null
}

Terug naar boven

Investigate metadata

GET yourdomain.timsaas.com/TimApi.service/Common.svc/GetMetaData?tablename=[tablename]

Description

Use this method to investigate the structure of the Tim database. At this moment in time the response is table based. Future versions of this method will be object type based.

For example:
The response of the GetObject method holds integer values as Categorie. To get the textual information assigned to this integer take these steps;

  • Use GetMetadata to get the information of the property Categorie.
  • Find the value of the property [PopupType].
  • Use GetLookupItems with PopupType to find the text in property [Name].
  •  

    Parameters

    Name Description
    id STRING – tablename

     

    Response

    {
    "GetMetaDataResult": {
    "Id": 1,
    "Name": "Bedrijf",
    "DocType": 1,
    "Fields": [
    {
    "Id": 1,
    "Name": "BedrijfNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": true,
    "IsSubCategory": false,
    "MaxLength": 15,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "BEDRIJF_NR",
    "Title": "bedrijf nummer",
    "VeldNr": 1,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 2,
    "Name": "AttNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 15,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "ATT_NR",
    "Title": "autoshow notitie",
    "VeldNr": 2,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 3,
    "Name": "Naam",
    "Decimals": 0,
    "Description": "Volledige naam van het bedrijf.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 60,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "NAAM",
    "Title": "bedrijfsnaam",
    "VeldNr": 3,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 339,
    "Name": "Mdw",
    "Decimals": 0,
    "Description": "Eigen medewerker die verantwoordelijk is voor de contacten met dit bedrijf.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 3,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "MDW",
    "Title": "medewerker",
    "VeldNr": 339,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 10,
    "Name": "ReisKm",
    "Decimals": 0,
    "Description": "Afstand in kilometers naar dit bedrijf (enkele reis)",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 11,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "REIS_KM",
    "Title": "reisafstand",
    "VeldNr": 10,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 11,
    "Name": "ReisTijd",
    "Decimals": 0,
    "Description": "Reistijd naar dit bedrijf (enkele reis)",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 8,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "REIS_TIJD",
    "Title": "reistijd",
    "VeldNr": 11,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 12,
    "Name": "Telefax",
    "Decimals": 0,
    "Description": "Faxnummer van algemene fax.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 35,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "TELEFAX",
    "Title": "algemene fax",
    "VeldNr": 12,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 13,
    "Name": "Telefoon",
    "Decimals": 0,
    "Description": "Telefoonnumer van centrale of receptie.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 35,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "TELEFOON",
    "Title": "telefoonnummer",
    "VeldNr": 13,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 14,
    "Name": "TelefoonV",
    "Decimals": 0,
    "Description": "Verkorte kiescode om met eigen centrale het nummer van dit bedrijf te kiezen.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "TELEFOON_V",
    "Title": "verkort kiesnummer",
    "VeldNr": 14,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 20,
    "Name": "Zoekcode",
    "Decimals": 0,
    "Description": "Verkorte code waarmee snel gezocht kan worden.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 15,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "ZOEKCODE",
    "Title": "zoekcode",
    "VeldNr": 20,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 22,
    "Name": "SoortNr",
    "Decimals": 0,
    "Description": "Rol van dit bedrijf ten opzichte van de eigen organisatie.",
    "IsCategory": true,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 1,
    "ReadOnly": false,
    "SqlName": "SOORT_NR",
    "Title": "categorie",
    "VeldNr": 22,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 5693,
    "Name": "SubCat",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": true,
    "MaxLength": 4,
    "PopupType": 268,
    "ReadOnly": false,
    "SqlName": "SUB_CAT",
    "Title": "subcategorie",
    "VeldNr": 5693,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 23,
    "Name": "BrancheCd",
    "Decimals": 0,
    "Description": "BIK branche codering (KvK)",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 6,
    "PopupType": 16,
    "ReadOnly": false,
    "SqlName": "BRANCHE_CD",
    "Title": "branche code",
    "VeldNr": 23,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 24,
    "Name": "KvkNr",
    "Decimals": 0,
    "Description": "Inschrijfnummer bij de kamer van koophandel.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 40,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "KVK_NR",
    "Title": "kvk nr",
    "VeldNr": 24,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 25,
    "Name": "AantWrkn",
    "Decimals": 0,
    "Description": "Het aantal vaste werknemers dat werkzaam is voor dit bedrijf.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 11,
    "PopupType": 16,
    "ReadOnly": false,
    "SqlName": "AANT_WRKN",
    "Title": "aantal werknemers",
    "VeldNr": 25,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 4423,
    "Name": "Grootte",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 203,
    "ReadOnly": false,
    "SqlName": "GROOTTE",
    "Title": "omzetgroep",
    "VeldNr": 4423,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 26,
    "Name": "Bron",
    "Decimals": 0,
    "Description": "Herkomst van eerste contact met dit bedrijf.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 60,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "BRON",
    "Title": "bron",
    "VeldNr": 26,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 1392,
    "Name": "MailAdres",
    "Decimals": 0,
    "Description": "Algemeen eMail adres van een bedrijf zoals info@... of receptie@...",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 60,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "MAIL_ADRES",
    "Title": "email adres algemeen",
    "VeldNr": 1392,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 4736,
    "Name": "StatusNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 221,
    "ReadOnly": false,
    "SqlName": "STATUS_NR",
    "Title": "status",
    "VeldNr": 4736,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 4737,
    "Name": "Rechtsvorm",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 222,
    "ReadOnly": false,
    "SqlName": "RECHTSVORM",
    "Title": "rechtsvorm",
    "VeldNr": 4737,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 4738,
    "Name": "Opgericht",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 8,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "OPGERICHT",
    "Title": "datum oprichting",
    "VeldNr": 4738,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 4739,
    "Name": "NoMail",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 1,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "NO_MAIL",
    "Title": "indicatie geen mail",
    "VeldNr": 4739,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 30,
    "Name": "FkBdrNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 11,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "FK_BDR_NR",
    "Title": "nvt",
    "VeldNr": 30,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 31,
    "Name": "VsNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "VS_NR",
    "Title": "geschonden voorschrift",
    "VeldNr": 31,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 1293,
    "Name": "VsCount",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "VS_COUNT",
    "Title": "aantal geschonden voorschriften",
    "VeldNr": 1293,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 1294,
    "Name": "VsMdw",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 3,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "VS_MDW",
    "Title": "mdw die voorschrift geschonden heeft",
    "VeldNr": 1294,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 2269,
    "Name": "ExtRef",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 60,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "EXT_REF",
    "Title": "externe referentie",
    "VeldNr": 2269,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": true
    },
    {
    "Id": 4833,
    "Name": "ExtInfo",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 8,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "EXT_INFO",
    "Title": "datum opschoning",
    "VeldNr": 4833,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 4847,
    "Name": "NoExInfo",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 1,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "NO_EX_INFO",
    "Title": "blokkade extern verrijken",
    "VeldNr": 4847,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 6548,
    "Name": "DubCheck",
    "Decimals": 0,
    "Description": "Een % waarde waaruit blijkt of een er tenminste 1 zelfde bedrijf bestaat.",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "DUB_CHECK",
    "Title": "dubbel score",
    "VeldNr": 6548,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 7928,
    "Name": "ConpersNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "CONPERS_NR",
    "Title": "standaard contactpersoon",
    "VeldNr": 7928,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 9190,
    "Name": "BrancheNr",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 464,
    "ReadOnly": false,
    "SqlName": "BRANCHE_NR",
    "Title": "branche",
    "VeldNr": 9190,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 32,
    "Name": "InDatum",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 8,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "IN_DATUM",
    "Title": "datum ingave",
    "VeldNr": 32,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 33,
    "Name": "InMdw",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 3,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "IN_MDW",
    "Title": "mdw ingave",
    "VeldNr": 33,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 34,
    "Name": "MutDatum",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 8,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "MUT_DATUM",
    "Title": "datum laatste wijziging",
    "VeldNr": 34,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 35,
    "Name": "MutCount",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 10,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "MUT_COUNT",
    "Title": "aantal wijzigingen",
    "VeldNr": 35,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 36,
    "Name": "MutMdw",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 3,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "MUT_MDW",
    "Title": "mdw laatste wijziging",
    "VeldNr": 36,
    "Visible": true,
    "Zoekveld": true,
    "Zoekveld2": false
    },
    {
    "Id": 9712,
    "Name": "SecId",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "SEC_ID",
    "Title": "",
    "VeldNr": 9712,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 9713,
    "Name": "SecMut",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "SEC_MUT",
    "Title": "",
    "VeldNr": 9713,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 9714,
    "Name": "SecDel",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "SEC_DEL",
    "Title": "",
    "VeldNr": 9714,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 9715,
    "Name": "SecRub",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "SEC_RUB",
    "Title": "",
    "VeldNr": 9715,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 9716,
    "Name": "SecVld",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": false,
    "SqlName": "SEC_VLD",
    "Title": "",
    "VeldNr": 9716,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    },
    {
    "Id": 9717,
    "Name": "Timestamp",
    "Decimals": 0,
    "Description": "",
    "IsCategory": false,
    "IsPartOfKey": false,
    "IsSubCategory": false,
    "MaxLength": 4,
    "PopupType": 0,
    "ReadOnly": true,
    "SqlName": "TIMESTAMP",
    "Title": "",
    "VeldNr": 9717,
    "Visible": false,
    "Zoekveld": false,
    "Zoekveld2": false
    }
    ],
    "PrimaryKeyName": "BedrijfNr",
    "SqlName": "BEDRIJF",
    "TableName": null,
    "TimLink": true,
    "Title": "Bedrijf"
    }
    }

    Terug naar boven

    View list information

    GET yourdomain.timsaas.com/TimApi.service/Common.svc/GetLookupItems?id=[id]

    Description

    Information returned by methods like GetObject hold integer values refering to textual descriptions in the actual application. Use this method as described in the description of GetMetaData.
     

    Parameters

    Name Description
    id INT – the value of the metadata property [PopupType]

     

    Response

    {
    "GetLookupItemsResult": [
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 2,
    "Name": "klant",
    "Tag": "",
    "Value": 2
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 1,
    "Name": "",
    "Tag": "",
    "Value": 1
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 13,
    "Name": "failliet",
    "Tag": "",
    "Value": 13
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 16,
    "Name": "concurrent",
    "Tag": "",
    "Value": 16
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 3,
    "Name": "leverancier",
    "Tag": "",
    "Value": 3
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 5,
    "Name": "gestopt",
    "Tag": "",
    "Value": 5
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 6,
    "Name": "relatie",
    "Tag": "",
    "Value": 6
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 8,
    "Name": "instelling",
    "Tag": "",
    "Value": 8
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 9,
    "Name": "eigen medewerker",
    "Tag": "",
    "Value": 9
    },
    {
    "Caption": null,
    "Extra": null,
    "Header": null,
    "Id": 10,
    "Name": "producent",
    "Tag": "",
    "Value": 10
    }
    ]
    }

    d

    Terug naar boven

    Search a file object with a filename

    GET yourdomain.timsaas.com/TimApi.service/Common.svc/GetFileObjectByFilename?filename=[filename]

    Description

    Using a Tim client you can automate the process of creating new documents. The Tim system is tightly integrated with Office365 to facilitate this process. This method can be used by a non-Office365 application to get the information of that file in the Tim database.

    Parameters

    Name Description
    filename STRING – Filename without extension.

     

    Response


    {
    "Properties": {
    "Filename": "160900191.xls",
    "OleNr": 1942,
    "Titel": "draaitabel vanuit tim",
    "Categorie": 0,
    "MailTitel": "",
    "Notities": "",
    "Notities2": "",
    "Referentie": "16.09.00191",
    "LokatieNr": 168,
    "Bestand": "160900191.xls",
    "Oleclass": "application/vnd.ms-excel",
    "AutoErase": false,
    "Geldigheid": null,
    "PersoonNr": 0,
    "VsNr": 0,
    "VsCount": 0,
    "VsMdw": " ",
    "InDatum": "2016-10-03T15:55:47.677",
    "InMdw": "TA ",
    "MutDatum": null,
    "MutCount": 0,
    "MutMdw": " ",
    "SecId": "AAAAAQ==",
    "SecMut": "AAAAAQ==",
    "Timestamp": "AAAAAACaAlo=",
    "DocNr": 0,
    "DocType": 0,
    "AttNr": 0,
    "SecDel": "AAAAAQ==",
    "Archief": "",
    "ProjectNr": 0,
    "OcrTxt": "",
    "SecRub": "AAAAAQ==",
    "ObjDatum": "2016-10-03T15:54:07.863",
    "Start": null,
    "Versie": "16.09.00191.1",
    "Origineel": 0,
    "SubCat": 0,
    "StatusNr": 0,
    "ExtRef": "",
    "GereedOp": null,
    "GereedDr": " ",
    "SecVld": "AAAAAQ==",
    "OcrDone": null,
    "OcrTresh": 0,
    "OcrLang": 0,
    "OcrIndex": 0,
    "SharepId": "306ddbd0-aca6-441e-a7b1-44eec5550bf6",
    "OnedrvId": "306ddbd0-aca6-441e-a7b1-44eec5550bf6",
    "Filestamp": null,
    "OdOrgId": ""
    },
    "Extra": null,
    "KeyWords": [],
    "Labels": [],
    "TimLinks": []
    }

    Terug naar boven

    View the properties and the contents of a file

    GET yourdomain.timsaas.com/TimApi.service/Common.svc/GetFileContent?id=[id]

    Description

    This method combines the usage of GetObject with the need for the binary content of a file. The properties are saved in the Tim database while the binary content is saved in the (externa) file storage. Traditionally this is a windows fileserver. TimWeb uses OneDrive for Business as external file storage.

    Parameters

    Name Description
    id INT – primary key of file object in Tim (ole_nr)

     

    Response

    {
    "GetFileContentResult": {
    "Binary": "0M8R4KGxGuEAAAAAAAA ..... 4KGxGuEAA",
    "Properties": {
    "Archief": "",
    "AttNr": 0,
    "AutoErase": false,
    "Bestand": "160900191.xls",
    "Categorie": 0,
    "DocNr": 0,
    "DocType": 0,
    "ExtRef": "",
    "Filestamp": "/Date(-2208992400000+0100)/",
    "Geldigheid": "/Date(-2208992400000+0100)/",
    "GereedDr": " ",
    "GereedOp": "/Date(-2208992400000+0100)/",
    "InDatum": "/Date(1475502947677+0200)/",
    "InMdw": "TA ",
    "LokatieNr": 168,
    "MailTitel": "",
    "MutCount": 0,
    "MutDatum": "/Date(-2208992400000+0100)/",
    "MutMdw": " ",
    "Notities": "",
    "Notities2": "",
    "ObjDatum": "/Date(1475502847863+0200)/",
    "OcrDone": "/Date(-2208992400000+0100)/",
    "OcrIndex": 0,
    "OcrLang": 0,
    "OcrTresh": 0,
    "OcrTxt": "",
    "OdOrgId": "",
    "OleNr": 1942,
    "Oleclass": "application/vnd.ms-excel",
    "OnedrvId": "306ddbd0-aca6-441e-a7b1-44eec5550bf6",
    "Origineel": 0,
    "PersoonNr": 0,
    "ProjectNr": 0,
    "Referentie": "16.09.00191",
    "SecDel": [
    0,
    0,
    0,
    1
    ],
    "SecId": [
    0,
    0,
    0,
    1
    ],
    "SecMut": [
    0,
    0,
    0,
    1
    ],
    "SecRub": [
    0,
    0,
    0,
    1
    ],
    "SecVld": [
    0,
    0,
    0,
    1
    ],
    "SharepId": "306ddbd0-aca6-441e-a7b1-44eec5550bf6",
    "Start": "/Date(-2208992400000+0100)/",
    "StatusNr": 0,
    "SubCat": 0,
    "Timestamp": [
    0,
    0,
    0,
    0,
    0,
    154,
    2,
    90
    ],
    "Titel": "draaitabel vanuit tim",
    "Versie": "16.09.00191.1",
    "VsCount": 0,
    "VsMdw": " ",
    "VsNr": 0
    }
    }
    }

    Terug naar boven