Tagor API (1.08.5000B3)

Download OpenAPI specification:

E-mail: info@organi.be

Release date: 16/08/2021

REQUIREMENTS

This version requires Tagor >= 1.08.5000B0. Use Config/Info to get the active API version.

CHANGELOG

New Config/Version endpoint.

INFO

Using the download button at the top you can import this collection of endpoints in Postman
In general all TQ(...)_Id fields are default fields which you can translate with the Code/GetDescription endpoint. If you need an id to post to one of the endpoints you can use the Code/GetList endpoint to get all possible values or Code/GetDescription to get a value by code. These id's will be marked as code id in the documentation.
We chose to return all ids as string because these are 64bit integers which are too big for javascript to handle.
All italic text below the endpoint description is meant for people with access to Tagor.
The user needs an email address configured in Tagor for the services to work properly.
Pass the Accept header with application/json as value to have the server return errors in json format.
Most endpoints can be batched/paged by passing a BATCH-SIZE and BATCH-NUMBER record in dsWebContext.

AUTHENTICATION

Pass your token via an Authorization header like this: Authorization: {bearer_format} {token}.

ex: Authorization: TGR IcoQbVw7wE...PPUPda61ET

Tgr

Authentication via Login/Token. Default authentication with Tagor username/password or API-key. For clients with an API-key there is a possibility to impersonate yourself as another Tagor user. This way the different user configurations can be used with the same key. To use this functionality simply pass an object in the ttWebContext array with:

key: user-login
value: the username

You can verify your call with the Config/User endpoint.

The user has to have the API permission set in the user management together with a valid email address. For an API-key to impersonate as another user the API impersonate toggle is required.

Security Scheme Type: HTTP

HTTP Authorization Scheme: bearer

Bearer format: Tgr

Hash

These endpoints can be directly called with the hash the defendant got by letter/email.

File hashes are generated with mergefield M_0585.

Security Scheme Type: HTTP

HTTP Authorization Scheme: bearer

Bearer format: Hash

Pin

These endpoints can be directly called with the pin the defendant got by letter/email in combination with the filename/archive number. Pass this as a base64 encoded string of {file}:{pin}

The value used in combination with the pincode is set in parameter 590. Pincodes are generated with mergefield M_0077.

Security Scheme Type: HTTP

HTTP Authorization Scheme: bearer

Bearer format: Pin

Orng

Pass the Orng token you received from the LDN backend (Organi only).

The customer id has to be set in parameter 589 and the environment code in parameter 587.

Security Scheme Type: HTTP

HTTP Authorization Scheme: bearer

Bearer format: Orng

Actions

Actions/SendMail

Send a mail. This endpoint will send a mail to the party entered in TPAR_Id if no TPAR_Id is passed it will send an email to the address passed in Emailadres. If TDOS_Id is passed the mail is only send if the file exists. When both TDOS_Id and TPAR_Id are passed, the party has to be a party connected to the file for the check to pass.

Parameter 569 has to contain the 117 connection string. In the office management screen a mailserver and mail template has to be configured. Logging about connection with the SMTP server can be found on c:\temp\YYYY\MM\DD\socketmail.log on the 117 server.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string",
"Emailadres": "string",
"CodeEmail": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

Actions/SendSms

Send a text. Requires TPAR_Id, Gsmnr or both. If a TPAR_Id is passed and the given party already has a communication number. The text will be send to this number. If not, or if you only pass the Gsmnr parameter the text will be send to this number instead.

Enter the RingRing API key in parameter 558. CodeSms can also be any TQCFG value configured in the office managment screen.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string",
"Gsmnr": "string",
"CodeSms": "SALDO"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

Code

Code/GetDescription

Converts code ids. Pass ttCodetabelIDs records with either Id or Code fields filled in. This endpoint will update the other fields and return the data.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsCodetabelIDs": {"dsCodetabelIDs": {"ttCodetabelIDs": [{"Tabel": "string",
"Id": "string",
"Code": "string",
"Taal": "Dut",
"Omschrijving": "string"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsCodetabelIDs": {"dsCodetabelIDs": {"ttCodetabelIDs": [{"Tabel": "string",
"Id": "string",
"Code": "string",
"Taal": "Dut",
"Omschrijving": "string"
}
]
}
}
}
}

Code/GetList

Returns a whole list of code ids. This endpoint can be used to populate dropdown lists in a front-end application.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Example

Get all possible statusses

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "table",
"ContextValue": "TQSTATUS"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsCodetabelIDs": {"dsCodetabelIDs": {"ttCodetabelIDs": [{"Tabel": "string",
"Id": "string",
"Code": "string",
"Taal": "Dut",
"Omschrijving": "string"
}
]
}
}
}
}

Config

Config/GetRequestableDocuments

Returns a list of all documents the user can generate.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsCodetabelIDs": {"dsDocuments": {"ttDocuments": [{"TDOCM_Id": "string",
"omschrijving": "string",
"Id": "string"
}
]
}
}
}
}

Config/Version

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "Version",
"ContextValue": "1.08.5000B3"
},
{"ContextKey": "VersionDate",
"ContextValue": null
},
{"ContextKey": "InstalledOn",
"ContextValue": null
}
]
}
}
}
}

Config/Info

Returns info about the bailiff's office. When called with a valid Authorization header the endpoint will return some technical info about the API aswell.

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "AppId",
"ContextValue": ""
},
{"ContextKey": "APIVersion",
"ContextValue": "1.08.5000B3"
},
{"ContextKey": "ConnectionString",
"ContextValue": "-AppService asb_tagorvoxtron_live -H ORWI-DB -S 5192 -sessionModel Session-free"
},
{"ContextKey": "MachineAPI",
"ContextValue": "ORWI-WWW"
},
{"ContextKey": "OEVersionAPI",
"ContextValue": "11.7.3.0.1592"
},
{"ContextKey": "MachineTagor",
"ContextValue": "ORWI-DB"
},
{"ContextKey": "OEVersionTagor",
"ContextValue": "10.2B"
},
{"ContextKey": "TagorVersion",
"ContextValue": "1.08.2000B5"
}
]
}
},
"dsTDOSPARWeb": {"dsTDOSPARWeb": {"ttTDOSPARWeb": [{"TPAR_Id": "9000000000000001706",
"Beroep": "",
"GSM": "",
"Naam": "Organi BVBA",
"Plaats": "",
"Postcode": "2610",
"Referentie": "",
"RekNr": "735030882966",
"Straat": "Dynamicalaan",
"StraatBusNr": "",
"StraatNr": "15",
"Tel": 38206300,
"TQPARSOORT_Id": "",
"TQSOLVABILITEIT_Id_Adres": "",
"TQSOLVABILITEIT_Id_Financieel": "",
"SolvDtm_adres": null,
"SolvDtm_finan": null,
"KBOnr": 441759675,
"NationaalNr": "",
"PartijVorm": "M",
"Mail": "info@organi.be",
"Sequence_Id": ""
}
]
}
}
}
}

Config/Ping

Checks the connection to the API and Tagor

Responses

Response Schema: application/json

object

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TAGOR",
"ContextValue": "true"
},
{"ContextKey": "API",
"ContextValue": "true"
}
]
}
}
}
}

Config/Ping

Checks the connection to the API and Tagor

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TAGOR",
"ContextValue": "true"
},
{"ContextKey": "API",
"ContextValue": "true"
}
]
}
}
}
}

Config/User

Return info about the current user.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSPARWeb": {"dsTDOSPARWeb": {"ttTDOSPARWeb": [{"TPAR_Id": "string",
"Beroep": "string",
"GSM": "string",
"Naam": "string",
"Plaats": "string",
"Postcode": "string",
"Referentie": "string",
"RekNr": "string",
"Straat": "string",
"StraatBusNr": "string",
"StraatNr": "string",
"Tel": "string",
"TQPARSOORT_Id": "string",
"TQSOLVABILITEIT_Id_Adres": "string",
"TQSOLVABILITEIT_Id_Financieel": "string",
"SolvDtm_adres": "string",
"SolvDtm_finan": "string",
"KBOnr": "string",
"NationaalNr": "string",
"PartijVorm": "string",
"Mail": "string"
}
]
}
}
}
}

Config/DefendantSettings

Get general settings.

Authorizations:

HashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Document

Document/Generate

A list of all possible TDOCM_Id values can be retreived with User/GetPermissionsList.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Document/Get

Get all documents on a file. ttWebContext requires a TDOS_Id element. The Inhoud field will always be empty here.

Some parameters can be used to configure this endpoint:

Parameter 192: Only show PDF files.
Parameter 369: Blacklist some security codes.
Parameter 430: _Allowed TQDISGROEPs. Empty for all. __

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOCWeb": {"dsTDOCWeb": {"ttTDOCWeb": [{"DatumDocument": "2019-08-24",
"DISFLMN_Extensie": "string",
"DISid": 0,
"Naam": "string",
"TDOC_Id": "string",
"TQDISGROEP_Id": "string",
"Inhoud": "string"
}
]
}
}
}
}

Document/GetFile

Get a single document on a file. ttWebContext requires a TDOC_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOC_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOCWeb": {"dsTDOCWeb": {"ttTDOCWeb": [{"DatumDocument": "2019-08-24",
"DISFLMN_Extensie": "string",
"DISid": 0,
"Naam": "string",
"TDOC_Id": "string",
"TQDISGROEP_Id": "string",
"Inhoud": "string"
}
]
}
}
}
}

Document/GetMergefield

Get one of the available mergefields on a file. ttWebContext requires TDOS_Id and Mergefield elements. You can get a list of all available mergefields by calling the User/GetPermissionsList endpoint and passing WL_QRY_FIELD as type.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
},
{"ContextKey": "Mergefield",
"ContextValue": "M_1000"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"ttWebContext": [{"ContextKey": "Output",
"ContextValue": "          \r\n19/03/2019 Bevel                                     60,00 EUR\r\n20/03/2019 Gemeengemaakt beslag                      14,11 EUR\r\n                                               ----------- ---\r\n           Totaal onder voorbehoud                   74,11 EUR\r\n"
}
]
}
}
}

Dossier

Dossier/AddAttachment

Add a document to a file. ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
},
"dsAttachmentWeb": {"dsAttachmentWeb": {"ttAttachmentWeb": [{"FileType": "txt",
"ttFileName": "classified.txt",
"TQDISGROEP_Id": 9000000000000000000,
"FileContent": "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ=="
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsAttachmentWeb": {"dsAttachmentWeb": {"ttAttachmentWeb": [{"ttFileName": "classified.txt",
"ttFilePath": "c:\\temp\\",
"ttComment": "",
"TDOC_Id": "9000000000000000001",
"TQDISGROEP_Id": "9000000000000000001",
"FileContent": "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==",
"FileType": "txt",
"TJOB_Id": null
}
]
}
}
}
}

Dossier/CreateInfoLine

Create an info record in a file.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSINFOWeb": {"dsTDOSINFOWeb": {"ttTDOSINFOWeb": [{"TDOS_Id": "9000000000000000001",
"TQINFO_Id": "9000000000000000001",
"TQINFODEF_Id": "9000000000000000001",
"Omschrijving": "Received call of defendant.",
"DatumInfo": "2019-12-12"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSINFOWeb": {"dsTDOSINFOWeb": {"ttTDOSINFOWeb": [{"TDOS_Id": "9000000000000000001",
"TQINFO_Id": "9000000000000000001",
"TQINFODEF_Id": "9000000000000000001",
"Omschrijving": "Received call of defendant.",
"DatumInfo": "2019-12-12"
}
]
}
}
}
}

Dossier/CreateLine

Add a transaction to a file.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSLIJNWeb": {"dsTDOSLIJNWeb": {"ttTDOSLIJNWeb": [{"Bedrag": 100,
"BedragBbConfrater": 0,
"BedragBTW": 2,
"Confrator": false,
"DatumBoeking": "2019-12-12",
"Omschrijving": "Payment received",
"Opmerking": "",
"Recht": 0,
"State": "",
"TDOS_Id": "9000000000000000001",
"TQAARD_Id": 0,
"TQBOEKING_Id": "9000000000000000001",
"Uitschot": 0
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSLIJNWeb": {"dsTDOSLIJNWeb": {"ttTDOSLIJNWeb": [{"Bedrag": 100,
"BedragBbConfrater": 0,
"BedragBTW": 2,
"Confrator": false,
"DatumBoeking": "2019-12-12",
"Omschrijving": "Payment received",
"Opmerking": "",
"Recht": 0,
"State": "",
"TDOS_Id": "9000000000000000001",
"TQAARD_Id": null,
"TQBOEKING_Id": "9000000000000000001",
"Uitschot": 0
}
]
}
}
}
}

Dossier/Get

Get a single file. ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSWeb": {"dsTDOSWeb": {"ttTDOSWeb": [{"Aanlegger": "string",
"Archiefnr": "string",
"DatumStop": "2019-08-24",
"Dossiernaam": "string",
"Klant": "string",
"KlantRef1": "string",
"KlantRef2": "string",
"SOLVDatum_adres": "2019-08-24",
"SOLVDatum_finan": "2019-08-24",
"StatusDatum": "2019-08-24",
"StatusDatum_Alarm": "2019-08-24",
"StatusDatum_Klant": "2019-08-24",
"StatusDatum_Stadium": "2019-08-24",
"TDOS_Id": "string",
"TQSOLV_Id_Adres": "string",
"TQSOLV_Id_Finan": "string",
"TQSTATUS_Id": "string",
"TQSTATUS_Id_Alarm": "string",
"TQSTATUS_Id_Klant": "string",
"TQSTATUS_Id_Stadium": "string",
"TQSTATUS_Id_Stop": "string",
"VerkoopDatum": "2019-08-24",
"Verweerder": "string",
"DatumCreatie": "2019-08-24",
"DatumWijziging": "2019-08-24",
"Subdossier": true,
"TQDOSSOORT_Id": "string"
}
]
}
}
}
}

Dossier/GetAgenda

Get all calendar items for a single file. ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTAGENDAWeb": {"dsTAGENDAWeb": {"ttTAGENDAWeb": [{"Omschrijving": "Payment received",
"TimeStampScheduled": "2019-12-12T00:00:00.000",
"TJOBM_Omschr": "",
"TQSTATUS_Id": "9000000000000000001",
"UserName": "User 1"
},
{"Omschrijving": "Message received",
"TimeStampScheduled": "2019-12-12T11:05:02.496",
"TJOBM_Omschr": "Webbericht",
"TQSTATUS_Id": "9000000000000000001",
"UserName": "User 2"
}
]
}
}
}
}

Dossier/GetAppearance

ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSVERSCHIJNINGWeb": {"dsTDOSVERSCHIJNINGWeb": {"ttTDOSVERSCHIJNINGWeb": [{"TQRB_Id": "string",
"Owning_RB_Entity": "string",
"Owning_RB_Id": "string",
"Plaats": "string",
"TQKAMER_Id": "string",
"TimeStampVerschijning": "string",
"Omschrijving": "string"
}
]
}
}
}
}

Dossier/GetBalances

Get all balances of a file i.e. returns a summarized version of Dossier/GetLines. ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSSALDOWeb": {"dsTDOSSALDOWeb": {"ttTDOSSALDOWeb": [{"TQSALDO_Id": "9000000000000000001",
"Bedrag": 100
},
{"TQSALDO_Id": "9000000000000000002",
"Bedrag": 0
}
]
}
}
}
}

Dossier/GetCorrespondence

Returns all correspondence on a file. ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSINFOWeb": {"dsTDOSINFOWeb": {"ttTDOSINFOWeb": [{"TDOS_Id": "9000000000000000001",
"TQINFO_Id": "9000000000000000001",
"TQINFODEF_Id": "0",
"Omschrijving": "Webbericht: Hi!",
"DatumInfo": "2019-12-12"
}
]
}
}
}
}

Dossier/GetInfo

Returns all info records on a file. ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSINFOWeb": {"dsTDOSINFOWeb": {"ttTDOSINFOWeb": [{"TDOS_Id": "9000000000000000001",
"TQINFO_Id": "9000000000000000001",
"TQINFODEF_Id": "0",
"Omschrijving": "Call from defendant.",
"DatumInfo": "2019-12-12"
}
]
}
}
}
}

Dossier/GetLines

Returns all transaction records on a file. ttWebContext requires a TDOS_Id element. Other options are optional:

is-defendant (boolean): returns the overview from the defendants perspective.
evolution-only (boolean): only returns records the office marked as 'important in the evolution of the file'.
unfinished-deeds (boolean)

To get files in the evolution-only view you have to mark TQAARD records as evolution.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSLIJNWeb": {"dsTDOSLIJNWeb": {"ttTDOSLIJNWeb": [{"Bedrag": 1000,
"BedragBbConfrater": 0,
"BedragBTW": 0,
"Confrator": false,
"DatumBoeking": "2019-12-12",
"Omschrijving": "Hoofdsom",
"Opmerking": "",
"Recht": 0,
"State": "",
"TDOS_Id": "9000000000000000001",
"TQAARD_Id": "0",
"TQBOEKING_Id": "9000000000000000001",
"Uitschot": 0
},
{"Bedrag": 150,
"BedragBbConfrater": 0,
"BedragBTW": 0,
"Confrator": false,
"DatumBoeking": "2019-11-12",
"Omschrijving": "Verworven IR: 0,00",
"Opmerking": "",
"Recht": 0,
"State": "",
"TDOS_Id": "9000000000000000001",
"TQAARD_Id": "0",
"TQBOEKING_Id": "9000000000000000001",
"Uitschot": 0
}
]
}
}
}
}

Dossier/GetParties

ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSPARWeb": {"dsTDOSPARWeb": {"ttTDOSPARWeb": [{"TPAR_Id": "string",
"Beroep": "string",
"GSM": "string",
"Naam": "string",
"Plaats": "string",
"Postcode": "string",
"Referentie": "string",
"RekNr": "string",
"Straat": "string",
"StraatBusNr": "string",
"StraatNr": "string",
"Tel": "string",
"TQPARSOORT_Id": "string",
"TQSOLVABILITEIT_Id_Adres": "string",
"TQSOLVABILITEIT_Id_Financieel": "string",
"SolvDtm_adres": "string",
"SolvDtm_finan": "string",
"KBOnr": "string",
"NationaalNr": "string",
"PartijVorm": "string",
"Mail": "string"
}
]
}
}
}
}

Dossier/GetPaymentPlans

ttWebContext requires a TDOS_Id element. Other options are optional:

active-only (boolean): only return active payment plans.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSAFBDETWeb": {"dsTDOSAFBDETWeb": {"ttTDOSAFBDETWeb": [{"TDOSAFB_Id": "string",
"Bedrag": "string",
"DatumBetaal": "2019-08-24",
"DatumTot": "2019-08-24",
"TQPERIODE_Id": "string",
"Sequence_Id": "string",
"Bedrag1stePeriode": "string",
"Datum1stePeriode": "2019-08-24"
}
]
}
}
}
}

Dossier/GetSub

ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSDOSWeb": {"dsTDOSDOSWeb": {"ttTDOSDOSWeb": [{"TDOS_Id_Sub": "string",
"Dossiernaam": "string",
"KlantRef1": "string"
}
]
}
}
}
}

Dossier/GetTitle

ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSTITELWeb": {"dsTDOSTITELWeb": {"ttTDOSTITELWeb": [{"TQRB_Id": "string",
"TQKAMER_Id": "string",
"Owning_RB_Entity": "string",
"Owning_RB_Id": "string",
"TimeStampTitel": "string",
"Omschrijving": "string"
}
]
}
}
}
}

Dossier/Search

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Example

Get all files of a defendant

Get all files of a defendant. The TQPARSOORT_Id can be retreived with the Code/GetDescription endpoint by getting the TQPARSOORT record with code VERW. This id will always stay the same so in theory you could also hardcode this.

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsFilter": {"dsFilter": {"ttFilter": [{"Veld": "partij",
"Operator": "begins",
"Waarde": "defandant name"
},
{"Veld": "TDOSPAR.TQPARSOORT_Id",
"Operator": "=",
"Waarde": "9000000000000000003"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSSearch": {"dsTDOSSearch": {"ttTDOSSearch": [{"Aanlegger": "string",
"Archiefnr": "string",
"DatumCreatie": "2019-08-24",
"DatumLtstBet": "2019-08-24",
"Dossiernaam": "string",
"Klant": "string",
"KlantRef1": "string",
"ReferteAdvocaat": "string",
"ReferteConfr": "string",
"TDOS_Id": "string",
"TQSTATUS_Id": "string",
"TQSTATUS_Id_Alarm": "string",
"TQSTATUS_Id_Klant": "string",
"TQSTATUS_Id_Stadium": "string",
"TQSTATUS_Id_Stop": "string",
"Verschijningsdatum": "2019-08-24",
"Verweerder": "string",
"TQDOSSOORT_Id": "string"
}
]
}
}
}
}

Dossier/Stop

ttWebContext requires a TDOS_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOS_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSWeb": {"dsTDOSWeb": {"ttTDOSWeb": [{"Aanlegger": "string",
"Archiefnr": "string",
"DatumStop": "2019-08-24",
"Dossiernaam": "string",
"Klant": "string",
"KlantRef1": "string",
"KlantRef2": "string",
"SOLVDatum_adres": "2019-08-24",
"SOLVDatum_finan": "2019-08-24",
"StatusDatum": "2019-08-24",
"StatusDatum_Alarm": "2019-08-24",
"StatusDatum_Klant": "2019-08-24",
"StatusDatum_Stadium": "2019-08-24",
"TDOS_Id": "string",
"TQSOLV_Id_Adres": "string",
"TQSOLV_Id_Finan": "string",
"TQSTATUS_Id": "string",
"TQSTATUS_Id_Alarm": "string",
"TQSTATUS_Id_Klant": "string",
"TQSTATUS_Id_Stadium": "string",
"TQSTATUS_Id_Stop": "string",
"VerkoopDatum": "2019-08-24",
"Verweerder": "string",
"DatumCreatie": "2019-08-24",
"DatumWijziging": "2019-08-24",
"Subdossier": true,
"TQDOSSOORT_Id": "string"
}
]
}
}
}
}

Dossier/GetByDefendant

ttWebContext requires a TPAR_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TPAR_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSWeb": {"dsTDOSDefendantWeb": {"ttTDOSDefendantWeb": [{"id": "string",
"status_id"": "string",
"defendant"": "string",
"creditor"": "string",
"balance_defendant"": 0,
"balance_office"": 0,
"file_name": "string"
}
]
}
}
}
}

Dossierlijn

Dossierlijn/GetInfo

Returns all info records on a financial record. ttWebContext requires a TDOSLIJN_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOSLIJN_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSLIJNINFOWeb": {"dsTDOSLIJNINFOWeb": {"ttTDOSLIJNINFOWeb": [{"financial_line_id": "9000000000000000001",
"type_id": "9000000000000000001",
"description": "Received call of defendant.",
"date": "2019-12-12"
}
]
}
}
}
}

Dossierlijn/DeleteInfoLine

Deletes a single info record.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TDOSLIJNINFO_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "success",
"ContextValue": "true"
}
]
}
}
}
}

Dossierlijn/CreateInfoLine

Create an info record on a financial record

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSLIJNINFOWeb": {"dsTDOSLIJNINFOWeb": {"ttTDOSLIJNINFOWeb": [{"financial_line_id": "9000000000000000001",
"type_id": "9000000000000000001",
"description": "Received call of defendant.",
"date": "2019-12-12"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": { }
},
"dsTDOSINFOWeb": {"dsTDOSINFOWeb": {"ttTDOSINFOWeb": [{"financial_line_id": "9000000000000000001",
"type_id": "9000000000000000001",
"description": "Received call of defendant.",
"date": "2019-12-12"
}
]
}
}
}
}

Login

Login/Token

If you received an API key from Organi there is no need to call this endpoint. The API key can be passed directly in the Authorization header.

client_credentials requires you to pass the Tagor credentials in client_id and client_secret.

Request Body schema: application/x-www-form-urlencoded

grant_type required	string Value: "client_credentials"
client_id	string
client_secret required	string

Responses

Response Schema: application/json

object

Response samples

200
400

Content type

application/json

{"response": {"token_type": "Tgr",
"expires_in": "3600",
"token": "string",
"error": "string"
}
}

Message

Message/Add

ttWebContext requires a TDOS_Id element. Pass a message in dsTBERICHTWeb. Optional attachments can be passed in dsAttachmentWeb.

Param 436 will be used to determine the message's disgroep. Defaults to 7006

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTBERICHTWeb": {"dsTBERICHTWeb": {"ttTBERICHTWeb": [{"TBERICHT_Id": "string",
"Ontvanger": "string",
"TJOB_Id": "string",
"TJOB_Onderwerp": "string",
"TJOB_TQSTATUS_Id": "string",
"TQSTATUS_Id": "string",
"TimeStampBericht": "string",
"TimeStampStatusSinds": "string",
"TQRICHTING_Id": "string",
"Verzender": "string",
"TJOB_bericht": "string",
"TPAR_id_Verzender": "string",
"TPAR_id_Ontvanger": "string",
"TDOS_Id": "string",
"TQDOSSOORT_Id": "string",
"ttTagWeb": [{"Omschrijving": "string",
"TQTEMPLATE_Id": "string"
}
]
}
]
}
},
"dsAttachmentWeb": {"dsAttachmentWeb": {"ttAttachmentWeb": [{"ttFileName": "string",
"ttFilePath": "string",
"ttComment": "string",
"TDOC_Id": "string",
"TQDISGROEP_Id": "string",
"FileContent": "string",
"FileType": "string",
"TJOB_Id": "string"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTBERICHTWeb": {"dsTBERICHTWeb": {"ttTBERICHTWeb": [{"TBERICHT_Id": "string",
"Ontvanger": "string",
"TJOB_Id": "string",
"TJOB_Onderwerp": "string",
"TJOB_TQSTATUS_Id": "string",
"TQSTATUS_Id": "string",
"TimeStampBericht": "string",
"TimeStampStatusSinds": "string",
"TQRICHTING_Id": "string",
"Verzender": "string",
"TJOB_bericht": "string",
"TPAR_id_Verzender": "string",
"TPAR_id_Ontvanger": "string",
"TDOS_Id": "string",
"TQDOSSOORT_Id": "string",
"ttTagWeb": [{"Omschrijving": "string",
"TQTEMPLATE_Id": "string"
}
]
}
]
}
},
"dsAttachmentWeb": {"dsAttachmentWeb": {"ttAttachmentWeb": [{"ttFileName": "string",
"ttFilePath": "string",
"ttComment": "string",
"TDOC_Id": "string",
"TQDISGROEP_Id": "string",
"FileContent": "string",
"FileType": "string",
"TJOB_Id": "string"
}
]
}
}
}
}

Message/GetListFilter

Same endpoint as Message/GetList. See this endpoint for the possible values in dsWebContext. This endpoint also accepts a dsFilter object that works the same as Dossier/Search.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Example

Get all messages send from/to the current user

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsFilter": {"dsFilter": {"ttFilter": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTBERICHTWeb": {"dsTBERICHTWeb": {"ttTBERICHTWeb": [{"TBERICHT_Id": "string",
"Ontvanger": "string",
"TJOB_Id": "string",
"TJOB_Onderwerp": "string",
"TJOB_TQSTATUS_Id": "string",
"TQSTATUS_Id": "string",
"TimeStampBericht": "string",
"TimeStampStatusSinds": "string",
"TQRICHTING_Id": "string",
"Verzender": "string",
"TJOB_bericht": "string",
"TPAR_id_Verzender": "string",
"TPAR_id_Ontvanger": "string",
"TDOS_Id": "string",
"TQDOSSOORT_Id": "string",
"ttTagWeb": [{"Omschrijving": "string",
"TQTEMPLATE_Id": "string"
}
]
}
]
}
},
"dsAttachmentWeb": {"dsAttachmentWeb": {"ttAttachmentWeb": [{"ttFileName": "string",
"ttFilePath": "string",
"ttComment": "string",
"TDOC_Id": "string",
"TQDISGROEP_Id": "string",
"FileContent": "string",
"FileType": "string",
"TJOB_Id": "string"
}
]
}
}
}
}

Message/GetLog

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTBERICHTWeb": {"dsTBERICHTWeb": {"ttTBERICHTWeb": [{"TBERICHT_Id": "string",
"Ontvanger": "string",
"TJOB_Id": "string",
"TJOB_Onderwerp": "string",
"TJOB_TQSTATUS_Id": "string",
"TQSTATUS_Id": "string",
"TimeStampBericht": "string",
"TimeStampStatusSinds": "string",
"TQRICHTING_Id": "string",
"Verzender": "string",
"TJOB_bericht": "string",
"TPAR_id_Verzender": "string",
"TPAR_id_Ontvanger": "string",
"TDOS_Id": "string",
"TQDOSSOORT_Id": "string",
"ttTagWeb": [{"Omschrijving": "string",
"TQTEMPLATE_Id": "string"
}
]
}
]
}
},
"dsAttachmentWeb": {"dsAttachmentWeb": {"ttAttachmentWeb": [{"ttFileName": "string",
"ttFilePath": "string",
"ttComment": "string",
"TDOC_Id": "string",
"TQDISGROEP_Id": "string",
"FileContent": "string",
"FileType": "string",
"TJOB_Id": "string"
}
]
}
}
}
}

Message/GetMessage

Gets a single message based on id. ttWebContext requires a TBERICHT_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TBERICHT_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTBERICHTWeb": {"dsTBERICHTWeb": {"ttTBERICHTWeb": [{"TBERICHT_Id": "string",
"Ontvanger": "string",
"TJOB_Id": "string",
"TJOB_Onderwerp": "string",
"TJOB_TQSTATUS_Id": "string",
"TQSTATUS_Id": "string",
"TimeStampBericht": "string",
"TimeStampStatusSinds": "string",
"TQRICHTING_Id": "string",
"Verzender": "string",
"TJOB_bericht": "string",
"TPAR_id_Verzender": "string",
"TPAR_id_Ontvanger": "string",
"TDOS_Id": "string",
"TQDOSSOORT_Id": "string",
"ttTagWeb": [{"Omschrijving": "string",
"TQTEMPLATE_Id": "string"
}
]
}
]
}
}
}
}

Message/GetSenderReceiverList

When this endpoint is called without any ttWebContext records it will return all groups a user belongs to. Other options are optional:

Type (enum senders or receivers): when senders is passed TPAR_Id is required.
TDOS_Id: active file you want to send a message on. This is required to get the groups of the user. Otherwise only the active user will be returned (if this user is allowed to send messages).
TPAR_Id: Id of the party you want to send messages to/from.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTDOSPARWeb": {"dsTDOSPARWeb": {"ttTDOSPARWeb": [{"TPAR_Id": "string",
"Beroep": "string",
"GSM": "string",
"Naam": "string",
"Plaats": "string",
"Postcode": "string",
"Referentie": "string",
"RekNr": "string",
"Straat": "string",
"StraatBusNr": "string",
"StraatNr": "string",
"Tel": "string",
"TQPARSOORT_Id": "string",
"TQSOLVABILITEIT_Id_Adres": "string",
"TQSOLVABILITEIT_Id_Financieel": "string",
"SolvDtm_adres": "string",
"SolvDtm_finan": "string",
"KBOnr": "string",
"NationaalNr": "string",
"PartijVorm": "string",
"Mail": "string"
}
]
}
}
}
}

Message/ToggleRead

Toggles the status of a message. ttWebContext requires a TBERICHT_Id element.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTBERICHTWeb": {"dsTBERICHTWeb": {"ttTBERICHTWeb": [{"TBERICHT_Id": "string",
"Ontvanger": "string",
"TJOB_Id": "string",
"TJOB_Onderwerp": "string",
"TJOB_TQSTATUS_Id": "string",
"TQSTATUS_Id": "string",
"TimeStampBericht": "string",
"TimeStampStatusSinds": "string",
"TQRICHTING_Id": "string",
"Verzender": "string",
"TJOB_bericht": "string",
"TPAR_id_Verzender": "string",
"TPAR_id_Ontvanger": "string",
"TDOS_Id": "string",
"TQDOSSOORT_Id": "string",
"ttTagWeb": [{"Omschrijving": "string",
"TQTEMPLATE_Id": "string"
}
]
}
]
}
}
}
}

Party

Parties represent natural persons as well as legal entities.

Party/Search

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Get by id.

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsFilter": {"dsFilter": {"ttFilter": [{"Veld": "TPAR.TPAR_Id",
"Operator": "=",
"Waarde": "9000000000000000003"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTPARSearch": {"dsTPARSearch": {"ttTPARSearch": [{"id": "string",
"first_name": "string",
"last_name": "string"
}
]
}
}
}
}

Party/AddContactDetail

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Get by id.

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTCOMWeb": {"dsTCOMWeb": {"ttTCOMWeb": [{"value": "info@organi.be",
"owning_id": "9000000000000000003",
"owning_entity": "TPAR",
"type_id": "9000000000000000003"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTCOMWeb": {"dsTCOMWeb": {"ttTCOMWeb": [{"id": "string",
"comment": "string",
"content": "string",
"owning_entity": "TPAR",
"owning_id": "string",
"type_id": "string",
"used": true,
"billing": true,
"mail_in_series": true
}
]
}
}
}
}

Party/DeleteContactDetail

Deletes a single contact record.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TCOM_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "success",
"ContextValue": "true"
}
]
}
}
}
}

Party/GetContactDetails

Get all contact details for a single party.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TPAR_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": { }
},
"dsTCOMWeb": {"dsTCOMWeb": {"ttTCOMWeb": [{"id": "9000000000000000001",
"value": "info@organi.be",
"owning_id": "9000000000000000001",
"owning_entity": "TPAR",
"type_id": "9000000000000000001"
}
]
}
}
}
}

Party/GetAddresses

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Get by id.

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TPAR_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTPARADWeb": {"dsTPARADWeb": {"ttTPARADWeb": [{"id": "string",
"party_id": "string",
"type_id": "string",
"street": "string",
"street_type_id": "string",
"number": "string",
"mailbox": "string",
"postal_code": "string",
"postal_code_type_id": "string",
"city": "string",
"city_type_id": "string",
"country": "string",
"country_type_id": "string",
"current_address": true
}
]
}
}
}
}

Pay

Endpoints for interaction with a payment gateway.

These endpoints require some configuration. Enter the correct parameters:

573 SIPS merchant id
574 SIPS secret
575 SIPS URL. This should be a base url without https prefix. ex: payment-webinit.sips-atos.com
576 SIPS Redirect URL. This is the page where SIPS should redirect to after payment. Like your front-end app.
577 SIPS Response URL. This is the page where SIPS posts its data after a payment. This should be the location of the Tagor 3 API. ex: https://api.organi.be/v1/rest/Pay/Finish
596: SIPS key version. Defaults to 1.

These parameters can be overwritten on the filetype configuration (TQDOSSOORT).

Pay/Finish

Finishes the payment process. This should only be called by the SIPS servers.

This endpoint will use the TagorService/OnlinePaymentReceived endpoint to create an informative payment record on the file.

query Parameters

redirectUrl

string

Request Body schema: application/x-www-form-urlencoded

Seal	string
InterfaceVersion	string
locale	string
Data	string

Responses

Pay/Start

Starts the payment process. This endpoint will return data that you'll have to post as a form to the given endpoint. Post redirectionVersion and redirectionData to redirectionUrl. You'll end up on the payment page. Look at the request samples for a javascript implementation.

Set parameter 576 with the return domain for the payment provider.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload
Javascript

Content type

application/json

{"request": {"Amount": "string",
"TDOS_Id": "string",
"Reference": "string",
"ReturnUrl": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"redirectionData": "string",
"redirectionStatusCode": "string",
"redirectionStatusMessage": "string",
"redirectionUrl": "string",
"redirectionVersion": "string",
"seal": "string"
}
}

TagorService

TagorService/ApprovePaymentPlan

Approve the last paymentplan on a file. If the given Telnr is a belgian mobile number the confirmation will be send as a text to that number. If not a mail will be send to the defendant on the file.

The formula with code BEVAFBET will be used as a template to send texts/mails. Be sure this record exists.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"Telnr": "string",
"Taal": "Dut"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Medium": "EMAIL"
}
}

TagorService/ClipToFile

Search for a phone number. This endpoint will return only the first matching party and its corresponding files.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"Telnr": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"TPAR_Id": "string",
"Taal": "Dut",
"Partijtype": "K",
"dsClipToFileDossiers": {"dsClipToFileDossiers": {"ttClipToFileDossiers": [{"TDOS_id": "string",
"Dossiernaam": "string",
"TQDOSSOORT_Id": "string",
"SaldoVerw": 0
}
]
}
}
}
}

TagorService/FileToHash

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"Dossiernaam": "string",
"Partijsoort": "string",
"Geboortedatum": "2019-08-24",
"BTWnr": "string",
"CodeSms": "string",
"CodeEmail": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

TagorService/GetDosInfo

Get info about a file.

DossiersoortId will be mapped if a mapping with code VOXTRON is available. Otherwise the id will be prefixed with DSO. DosbehId depends on parameter 259. See the result below for possible values.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Dossiernaam": "string",
"Aanlegger": "string",
"Verweerder": "string",
"DossiersoortId": "string",
"StatusId": "string",
"StadiumId": "string",
"StadiumKlantId": "string",
"StopstatusId": "string",
"AlarmstatusId": "string",
"DosbehId": "string",
"EmailVerweerder": "string",
"GsmVerweerder": "string",
"DatumLtstBet": "2019-08-24",
"BedragLtstBet": 0.1,
"DatumLtstOnbvBet": "2019-08-24",
"BedragLtstOnbvBet": 0.1,
"UrlFAQ": "string"
}
}

TagorService/GetPaymentPlanCriteria

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Termijn1": 0,
"Bedrag1": 0,
"Termijn2": 0,
"Bedrag2": 0,
"TermijnMax": 0,
"BedragMax": 0,
"PaymentPlanId": "string"
}
}

TagorService/GetSaldo

Get the defendants balance on a file. This endpoint will create an info record (type OPSV) on the file indicating the balance was requested unless.

The auto created info records can be disabled with parameter 568. This endpoint returns the balance with code VRW which is the defendants balance on the file.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"IPadres": "string",
"Telnr": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Saldo": 0
}
}

TagorService/GetVoxtronReferentie

DossiersoortId and DosStatus will be mapped if a mapping with code VOXTRON is available. Otherwise the id will be prefixed with DSO.Parameter 303 effects the way the Referentie field is used to search for a file. DosbehId depends on parameter 259. See the result below for possible values. Parameter 233 decides whether the file status or file stage status is returned in the DosStatus field.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"Referentie": "string",
"Telnr": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"DosSoortId": "string",
"DosBehId": "string",
"DosStatus": "string",
"AantalVerw": 0,
"VolgNrVerw": 0,
"DosId": "string",
"Dagvaarding": true,
"ReturnCode": "string"
}
}

TagorService/GetVoxtronVerwByHuisNr

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"DosId": "string",
"HuisNr": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"VolgNrVerw": 0,
"ReturnCode": "string"
}
}

TagorService/GetVoxtronVerwByPin

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"DosId": "string",
"Pin": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

TagorService/HashToFile

Get the corresponding file for a file-hash.

The tokens validity period is configurable in parameter 502

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"Dossierhash": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"TDOS_Id": "string",
"TPAR_Id": "string",
"Taal": "Dut",
"GeldigTot": "string"
}
}

TagorService/KantoorOpen

Checks if an employe is available based on file type.

Opening hours can be entered via the configuration menu in Tagor.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"KantoorOpen": true
}
}

TagorService/OnlinePaymentReceived

Creates an informative payment record on a file.

The line's nature has to be configured in Tagor's office managment tool.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"Bedrag": "string",
"TDOS_Id": "string",
"TPAR_Id": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

TagorService/PaymentInfo

Get info about ongoing payment plans on a file.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Betaalplan": true,
"Maandbedrag": 0.1,
"Achterstand": 0.1
}
}

TagorService/PinToFile

Get the file id from a filename/pin combination. The value used in combination with the pin doesn't have to be a file name. This is configurable in Tagor.

The value used in combination with the pincode is set in parameter 590. Pincodes are generated with mergefield M_0077.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"Dossier": "string",
"Pin": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"TDOS_Id": "string",
"TPAR_Id": "string"
}
}

TagorService/SavePaymentPlan

Add a payment plan to a file. This will always create a new payment plan and put all existing payment plans inactive. The input data is validated. Periodes has to be less than configured on the file type. An info records will be generated to indicate a new payment plan was requested.

Payment plans can be auto accepted with parameter 358. The auto created info records can be disabled with parameter 568. The default date can be configured in the file type config and in the office managment.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string",
"Bedrag": 0,
"Periodes": 0,
"Startdatum": "2019-08-24",
"IPadres": "192.168.0.1",
"Telnr": "string",
"RekeningId": "string",
"OverrideChecks": false
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Periodes": 0,
"Bedrag": 0.1
}
}

TagorService/SelfServiceAllowed

Checks whether a user is allowed to request his/her file.

Configuration should be done in Tagor's office management tool.

Authorizations:

OrngTgrHashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"Config": "string",
"Telnr": "string"
}
}

Response samples

200

Content type

application/json

Example

Success

{"response": {"Success": true,
"Error": ""
}
}

TagorService/SendMail Deprecated

Deprecated in favor of Actions/SendMail. Will be removed in 1.08.3000B0.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string",
"Emailadres": "string",
"CodeEmail": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

TagorService/SendSms Deprecated

Deprecated in favor of Actions/SendSms. Will be removed in 1.08.3000B0.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"TDOS_Id": "string",
"TPAR_Id": "string",
"TelNr": "string",
"CodeSms": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

TagorService/SetUserDossier

Adds shortcut to a specific file for a specific user in Tagor.

Default info type can be changed in the CURCALL mapping.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object (SuccessErrorResponse)

Request samples

Payload

Content type

application/json

{"request": {"UserLogin": "string",
"DosId": "string",
"TelNr": "string",
"Direction": "IN"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string"
}
}

TagorService/PaymentDetails

Endpoint to get a detailed overview of the file.

Authorizations:

HashPin

Responses

Response Schema: application/json

object

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"Data": "string"
}
}

TagorService/ScanBarcode

Get the file/financial line connected to a barcode.

Authorizations:

HashPin

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"barcode": "string"
}
}

Response samples

200

Content type

application/json

{"response": {"Success": true,
"Error": "string",
"file_id": "string",
"line_id": "string",
"fixed": true
}
}

User

Users represents Tagor users. This can be software users and api users. A user extends a Party by adding a username and some other extras.

User/Add

Add/Create a user. Pass the TPAR_Id if you want to create a User for an existing Party.

Optional you can pass a BASE-USER context record with as value a TUSER_Id to inherit the web configuration of this user.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Example

Create user

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTUSERWeb": {"dsTUSERWeb": {"ttTUSERWeb": [{"party_id": "9000000000000000001",
"username": "organi",
"name": "Organi",
"password": "*************",
"landline": 328206300,
"email_address": "info@organi.be"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTUSERWeb": {"dsTUSERWeb": {"ttTUSERWeb": [{"id": "9000000000000000001",
"party_id": "9000000000000000001",
"username": "organi",
"name": "Organi",
"password": "",
"landline": 328206300,
"fax": "",
"cellphone": "",
"email_address": "info@organi.be"
}
]
}
}
}
}

User/Get

Get a user by id

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TUSER_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTUSERWeb": {"dsTUSERWeb": {"ttTUSERWeb": [{"id": "9000000000000000001",
"party_id": "9000000000000000001",
"username": "organi",
"name": "Organi",
"password": "",
"landline": 328206300,
"fax": "",
"cellphone": "",
"email_address": "info@organi.be",
"requires_2fa": false
}
]
}
}
}
}

User/GetPermissions

Get all (single) permissions of a user. This will return all the permissions that are represented as a toggle in Tagor. i.e. all permissions on the Web permissies tab.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsConfigWeb": {"dsConfigWeb": {"ttConfigWeb": [{"data": "string",
"type_id": "string",
"type_code": "string"
}
]
}
}
}
}

User/GetPermissionsList

List all permissions of a user by type. Via this endpoint you'll be able to retreive al permissions with mutliple values. In general this endpoint is for all permissions on the Web configuratie tab in Tagor.

Possible type values:

WEBT3001 or TPAR = Party
- Get a list of parties + party types. These have to be on a file for a user to be allowed to view the file.
- Unlike the other types this will return a pipe separated value of both party id and party type id
WEBT3002 or TQDOSSOORT = File type
- Returns a list of all file types a user is allowed to see
WEBT3006 or TQDISGROEP = Document types
- Returns a list of all document types a user can use when adding a document
WEBT3007 or WL_QRY_FIELD = Mergefields
- Returns a list of all mergefields a user is able to request with Document/GetMergefield
- If a user doesn't have any mergefields configured the default setting from the office configuration screen will be used.
WEBT3005 or TDOCM = Document types
- Returns a list of all TDOCM_Ids a user is able to request in Document/Generate
WEBT3004 or TQDOCSECURITY = Document security
- Returns a list of all document security types a user is able to see

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

Example

Get all filetype permissions.

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TYPE",
"ContextValue": "TQDOSSOORT"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{ }
]
}
},
"dsCodeWeb": {"dsCodeWeb": {"ttCodeWeb": [{"type": "TQDOSSOORT",
"id": "9000000000000000001",
"code": "EX",
"language": "Dut",
"description": "Example File Type"
}
]
}
}
}
}

User/SavePermissions

Save all (single) permissions of a user.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsConfigWeb": {"dsConfigWeb": {"ttConfigWeb": [{"data": "string",
"type_id": "string",
"type_code": "string"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsConfigWeb": {"dsConfigWeb": {"ttConfigWeb": [{"data": "string",
"type_id": "string",
"type_code": "string"
}
]
}
}
}
}

User/SavePermissionsList

Save a list of all permissions of a user by type. See User/GetPermissionsList for all possible type values. All current values for the specified user + type will be deleted and overwritten with the posted valued. If you want to add a value use User/GetPermissionsList to get all current values, add the value to the array and post it to this endpoint. Note: for the TPAR permissions two values are required and should be passed in the id field, seperated by a pipe.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "USER-LOGIN",
"ContextValue": "ORGANI"
}
]
}
},
"dsCodeWeb": {"dsCodeWeb": {"ttCodeWeb": [{"type": "TQDOSSOORT",
"id": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsCodeWeb": {"dsCodeWeb": {"ttCodeWeb": [{"type": "string",
"id": "string",
"code": "string",
"language": "string",
"description": "string"
}
]
}
}
}
}

User/CanAccess

This endpoint returns the users that have access to the given asset. E.g. If you pass TQDOSSOORT_Id, you'll get all users allowed to view files of this type. Pass one or more of the following filetypes:

TQDOSSOORT_Id
TPAR_Id. For filtering a party regardless of type.
TPAR|TQPARSOORT_Id. For filtering a party with matching party type. Pass both TPAR_Id and TQPARSOORT_Id in a context record separated by a pipe. ex: 9000000000000000001|9000000000000000001.

This searches the values configured on the web configuration tab in the user managment.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TPAR_Id",
"ContextValue": "9000000000000000001"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsTUSERWeb": {"dsTUSERWeb": {"ttTUSERWeb": [{"id": "string",
"party_id": "string",
"username": "string",
"name": "string",
"password": "string",
"landline": "string",
"fax": "string",
"cellphone": "string",
"email_address": "string",
"requires_2fa": true
}
]
}
}
}
}

SolvencyReport

SolvencyReport/GetList

You can pass an additional TQDOSSOORT_Id to get file type specific config.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsCodetabelIDs": {"dsCodetabelIDs": {"ttCodetabelIDs": [{"Tabel": "string",
"Id": "string",
"Code": "string",
"Taal": "Dut",
"Omschrijving": "string"
}
]
}
}
}
}

SolvencyReport/Get

This endpoint expects some values in ttWebContext. See example.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TCFGSOLVRAPMOD_Id",
"ContextValue": 9000000000000000000
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [ ]
}
},
"dsSolvencyReport": {"dsSolvencyReport": {"ttSolvencyReport": [{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"val": "string"
}
]
}
}
}
}

SolvencyReport/Save

This endpoint expects some values in ttWebContext. See example.

Authorizations:

OrngTgr

Request Body schema: application/json

object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"request": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "TCFGSOLVRAPMOD_Id",
"ContextValue": 9000000000000000000
},
{"ContextKey": "TDOS_Id",
"ContextValue": 9000000000000000000
},
{"ContextKey": "TPAR_Id",
"ContextValue": 9000000000000000000
},
{"ContextKey": "TPARAD_Id",
"ContextValue": 9000000000000000000
}
]
}
},
"dsSolvencyReport": {"dsSolvencyReport": {"ttSolvencyReport": [{"id": "9000000000000000560",
"val": "W1"
},
{"id": "9000000000000000558",
"val": "true"
},
{"id": "9000000000000000556",
"val": "6.4"
}
]
}
}
}
}

Response samples

200

Content type

application/json

{"response": {"dsWebContext": {"dsWebContext": {"ttWebContext": [{"ContextKey": "success",
"ContextValue": true
}
]
}
}
}
}