Reporting API for direct assessments
With these API calls you can run Reports and Assessments by giving a webservice call to the correct API.
Below is all the documentation you need.
We have also made some publiv Postman example calls:
https://documenter.getpostman.com/view/5442482/UVJeEbc4
Getting a token for reporting and assessment
POST GetReportingToken
https://web.terraindex.com/ReportWS/tokenmanager/ReportingToken/
HEADERS
Content-Type: application/json
BODYraw
{
"Username": "your_username",
"Password": "some_password",
"Licensenumber": "licenseNr",
"ApplicationCode": x
}
Username + Password:
The username and password to login to TerraIndex. If you don't known yours, ask the application manager of your company.
He or she can create an account for you in TerraIndex Web.
Licensenumber:
The licensenumber of the customer. If you don't known yours, ask the servicdesk of TerraIndex.
ApplicationCode:
The applicationcode that is given to your appliction that tries to connect our API's. If you don't known yours, ask the servicdesk of TerraIndex.
Example value: 1
Example Reponse
{
"log": null,
"Result": "QzhGQTZDQzIxNEE1Mzg5RjUxRTI2QjgwMTM2RThFN0E2OTUwQ0E3RjlCNUNGNDMyOTNBODY5NkNEQkU0QTU2QTQ1RjJENDFEMEFDMTA2RTBDRjhFREYwNzUzMEFCRkZCNDRERjMzMEVCREE4RDZCOTdCNkZCNTA5NEY4OThFQ0RBQjIxQTQzNzZEQjQyQzc3NjUxRTIwQTZCMEI1QjIxNTFDMzVDQzE4QjM2OTRBRkE1NjJBNUExMjU3NDg4QkJCQjcwMzNENEVDMjg5QTVFOENBMEUzRTU0REE2QkRDRkIyQkEwMTI3RDQ4NDkzMjY1MzAwREExRDVCRjZFM0ZFNTgzRTJDREY5MzQ1NDcwMkJBRjE0NjE4MzFDRDA2OUZBN0IyOUNGRkE1MkZFN0Q5MUQ0MjQ2ODFBNjY5ODBGNkRBRTZDRjc5NDAwRDM4NkY1NkQzRjAyQjcyMDA4NDAwNDA5QTdBM0JBRTMyRkIwNjg1MUZCQkMyQjc1MjBGQjdERUI2QThEN0Q3QjE0RDlDN0I3MjFBQkUxNDg5QkY1REUyQjMyOTNCREQ3ODlFRkU5QTJDQUY5MDRBRUJGNzVCMjYwNEFEMUQxMjFGREM5RkM1NDlEMTMxMjhDMkMwOTlBMDZGNkJDNTExN0E4NjZDRDE4N0ZGQzFBQTNFRDQyMkVGMkIzNzA1QTJFMUQ5MzIzMUMwMDkyMTM3NzZDRjIwMTkyRTUzRkI3MUIxQUI2RTMwMDExNEQ3MDkyRDE0NzdBMDlENjdBNUE0NTE0Mjk5NkI5QjQ2MzQ0QTc0MUQ1NDI3QjhBMTUyRTU1RTM5Mjc0REE4RkI1NjY0QTlDQTdDNDIyRTI2NEFCQUY5OTIyODc4RDAxREQ0Njk2NDBEMDhBQkM2QTQyRjAyRkE0Q0RBRDE0NkE0MkJEQ0U5REY0OTMzMDlGQUE2QzJFN0EyMkVCODdGNEE2NTIwMDZBMEJDOA",
"ResultCode": 0,
"Message": null
}
ResultCode:
0 = SUCCES
1 = ERROR
Result:
is the token for the next calls, this token is valid for 1 hour.
Starting a report with assessments
POST CreateReport WBB toetsing
https://web.terraindex.com/ReportWS/repmanager/CreateReport/W/{ReportID}/{ProjectID}/{Assessments}?lang=nl
https://web.terraindex.com/ReportWS/repmanager/CreateReport/W/1276/2953/17,18,19,20?lang=nl
HEADERS
Authorization "Bearer {{token}}"
example: Bearer QzhGQTZDQzIxNEE1Mzg5RjUxRTI2QjgwMTM2RThFN0E2OTUwQ0E3RjlCNUNGNDMyOTNBODY5NkNEQkU0QTU2QTQ1RjJENDFEMEFDMTA2RTBDRjhFREYwNzUzMEFCRkZCNDRERjMzMEVCREE4RDZCOTdCNkZCNTA5NEY4OThFQ0RBQjIxQTQzNzZEQjQyQzc3NjUxRTIwQTZCMEI1QjIxNTFDMzVDQzE4QjM2OTRBRkE1NjJBNUExMjU3NDg4QkJCQjcwMzNENEVDMjg5QTVFOENBMEUzRTU0REE2QkRDRkIyQkEwMTI3RDQ4NDkzMjY1MzAwREExRDVCRjZFM0ZFNTgzRTJDREY5MzQ1NDcwMkJBRjE0NjE4MzFDRDA2OUZBN0IyOUNGRkE1MkZFN0Q5MUQ0MjQ2ODFBNjY5ODBGNkRBRTZDRjc5NDAwRDM4NkY1NkQzRjAyQjcyMDA4NDAwNDA5QTdBM0JBRTMyRkIwNjg1MUZCQkMyQjc1MjBGQjdERUI2QThEN0Q3QjE0RDlDN0I3MjFBQkUxNDg5QkY1REUyQjMyOTNCREQ3ODlFRkU5QTJDQUY5MDRBRUJGNzVCMjYwNEFEMUQxMjFGREM5RkM1NDlEMTMxMjhDMkMwOTlBMDZGNkJDNTExN0E4NjZDRDE4N0ZGQzFBQTNFRDQyMkVGMkIzNzA1QTJFMUQ5MzIzMUMwMDkyMTM3NzZDRjIwMTkyRTUzRkI3MUIxQUI2RTMwMDExNEQ3MDkyRDE0NzdBMDlENjdBNUE0NTE0Mjk5NkI5QjQ2MzQ0QTc0MUQ1NDI3QjhBMTUyRTU1RTM5Mjc0REE4RkI1NjY0QTlDQTdDNDIyRTI2NEFCQUY5OTIyODc4RDAxREQ0Njk2NDBEMDhBQkM2QTQyRjAyRkE0Q0RBRDE0NkE0MkJEQ0U5REY0OTMzMDlGQUE2QzJFN0EyMkVCODdGNEE2NTIwMDZBMEJDOA
Params:
ReportID = the ID of the report that needs to be generated, example value for Wbb zonder kleur (BoToVa): '1276'.
ProjectID = the project ID to create the report and assesment, example value: '2953'
Assessments = the Assessments that need to be done, example values for Dutch WBB and BBK: '17,18,19,20'
Example Reponse
{
"log": {},
"Result": "b5e3117a-2e16-4769-b277-78e1758e5f2c",
"ResultCode": 0,
"Message": ""
}
ResultCode:
0 = SUCCES
1 = ERROR
Result:
is the JobID for the next calls to get the progress.
Getting the progress of the Job
GET GetProgress
https://web.terraindex.com/ReportWS/repmanager/getprogress/{{progresskey}}?lang=en
HEADERS
Authorization "Bearer {{token}}"
example: Bearer QzhGQTZDQzIxNEE1Mzg5RjUxRTI2QjgwMTM2RThFN0E2OTUwQ0E3RjlCNUNGNDMyOTNBODY5NkNEQkU0QTU2QTQ1RjJENDFEMEFDMTA2RTBDRjhFREYwNzUzMEFCRkZCNDRERjMzMEVCREE4RDZCOTdCNkZCNTA5NEY4OThFQ0RBQjIxQTQzNzZEQjQyQzc3NjUxRTIwQTZCMEI1QjIxNTFDMzVDQzE4QjM2OTRBRkE1NjJBNUExMjU3NDg4QkJCQjcwMzNENEVDMjg5QTVFOENBMEUzRTU0REE2QkRDRkIyQkEwMTI3RDQ4NDkzMjY1MzAwREExRDVCRjZFM0ZFNTgzRTJDREY5MzQ1NDcwMkJBRjE0NjE4MzFDRDA2OUZBN0IyOUNGRkE1MkZFN0Q5MUQ0MjQ2ODFBNjY5ODBGNkRBRTZDRjc5NDAwRDM4NkY1NkQzRjAyQjcyMDA4NDAwNDA5QTdBM0JBRTMyRkIwNjg1MUZCQkMyQjc1MjBGQjdERUI2QThEN0Q3QjE0RDlDN0I3MjFBQkUxNDg5QkY1REUyQjMyOTNCREQ3ODlFRkU5QTJDQUY5MDRBRUJGNzVCMjYwNEFEMUQxMjFGREM5RkM1NDlEMTMxMjhDMkMwOTlBMDZGNkJDNTExN0E4NjZDRDE4N0ZGQzFBQTNFRDQyMkVGMkIzNzA1QTJFMUQ5MzIzMUMwMDkyMTM3NzZDRjIwMTkyRTUzRkI3MUIxQUI2RTMwMDExNEQ3MDkyRDE0NzdBMDlENjdBNUE0NTE0Mjk5NkI5QjQ2MzQ0QTc0MUQ1NDI3QjhBMTUyRTU1RTM5Mjc0REE4RkI1NjY0QTlDQTdDNDIyRTI2NEFCQUY5OTIyODc4RDAxREQ0Njk2NDBEMDhBQkM2QTQyRjAyRkE0Q0RBRDE0NkE0MkJEQ0U5REY0OTMzMDlGQUE2QzJFN0EyMkVCODdGNEE2NTIwMDZBMEJDOA
Params:
progresskey = the JobID of the report generation and assessment job, example value: 'b5e3117a-2e16-4769-b277-78e1758e5f2c'.
Example Reponse
{
"log": {},
"Result": {
"Key": "b5e3117a-2e16-4769-b277-78e1758e5f2c",
"Progress": 100,
"Remark": null,
"RequestTime": "2021-11-30T17:00:59.6361124+01:00",
"CompletedTime": "2021-11-30T17:01:03.767075+01:00",
"FilePath": "",
"HtmlResult": null,
"DownLoadUrl": "/temp/b5e3117a-2e16-4769-b277-78e1758e5f2c/Wbb zonder kleur (BoToVa)(20210818_DEMO).docx"
},
"ResultCode": 0,
"Message": null }
ResultCode:
0 = SUCCES
1 = ERROR
Progress:
the actual progress of the job between 0% to 100%. When the progress is 100%, the DownloadURL will be filled.
DownLoadUrl:
The url to download the actual document that is generated. In the backend all your assessment data is stored in the database and tries to represent in this requested document.
https://web.terraindex.com/ReportWS/{{DownLoadUrl}}
https://web.terraindex.com/ReportWS/temp/b5e3117a-2e16-4769-b277-78e1758e5f2c/Wbb zonder kleur (BoToVa)(20210818_DEMO).docx