| VismaBouwsoftAPICalls.v1_GET_Todos | Method |
This API call is used to get fields of a(n) Todo(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Todos/
or
API Path: /Todos/{id}
or
API Path: /Todos/{id}/conclusion_html
or
API Path: /Todos/{id}/conclusion_plain
or
API Path: /Todos/{id}/conclusion_rtf
or
API Path: /Todos/{id}/image
or
API Path: /Todos/{id}/introduction_html
or
API Path: /Todos/{id}/introduction_plain
or
API Path: /Todos/{id}/introduction_rtf
or
API Path: /Todos/{id}/note_html
or
API Path: /Todos/{id}/note_plain
or
API Path: /Todos/{id}/note_rtf
You can make this API call:
* without the key field id to get a list of Todos
* with the key field id as the path parameter (the specific id of the Todo you want to get)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| nr | Number |
| list | String |
| date_created | String |
| date_expiry | String |
| title | String |
| concerning | String |
| greeting | String |
| greeting_localized | String |
| salutation | String |
| salutation_localized | String |
| sender | String |
| function | String |
| function_localized | String |
| company_id | Number |
| company_name | String |
| address_id | Number |
| address_name | String |
| address_address | String |
| address_addressline2 | String |
| address_countrycode | String |
| address_zipcode | String |
| address_city | String |
| address_telephone1 | String |
| address_email | String |
| address_vatnr | String |
| contact_id | Number |
| contact_name | Number |
| project_id | Number |
| project_pnr | Number |
| project_unr | Number |
| project_name | String |
| yourreference | String |
| completed | Boolean |
/Todos/
API Path: /Todos/
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: kklfWxfGVIzSfbjjPfzRqrOGfIflfGImfUIkzfjVkGjGfOtItf
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/211”,
“Records”:
[
{
"id": 2,
"nr": 2,
"list": "Installatie",
"date_created": "2012–03–12",
"date_expiry": "2012–03–19",
"title": "Installatie",
"concerning": "Afwerken van plinten",
"greeting": "Groeten.",
"greeting_localized": "Regards",
"salutation": "",
"salutation_localized": "",
"sender": "Lutters Carl",
"function": "Bestuurder",
"function_localized": "Director",
"company_id": 1,
"company_name": "Bouwsoft",
"address_id": 34,
"address_name": "A. OTTE EN ZOON",
"address_address": "HAVENWEG 20",
"address_addressline2": "",
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"address_telephone1": "+32 3 101 14 11 ",
"address_email": "",
"address_vatnr": "NL 813209791B01",
"contact_id": 0,
"contact_name": 0,
"project_id": 3,
"project_pnr": 20120003,
"project_unr": 3,
"project_name": "Project: Parketvloeren",
"yourreference": "",
"completed": true
},
{
"id": 3,
"nr": 3,
"list": "Installatie",
"date_created": "2012–03–20",
"date_expiry": "2012–03–27",
"title": "Restoring the canvas",
"concerning": "Art & decoration of the Pestana London",
"greeting": "Groeten.",
"greeting_localized": "Regards",
"salutation": "Beste Mevrouw",
"salutation_localized": "Dear Madam",
"sender": "Lutters Carl",
"function": "CEO",
"function_localized": "CEO",
"company_id": 1,
"company_name": "Bouwsoft",
"address_id": 41641,
"address_name": "’T KLOKKENHOF NV",
"address_address": "",
"address_addressline2": "",
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"address_telephone1": "",
"address_email": "",
"address_vatnr": "m_bBTWNrWijzigbaar",
"contact_id": 32301,
"contact_name": 0,
"project_id": 1673,
"project_pnr": 20180385,
"project_unr": 201800111,
"project_name": "’T KLOKKENHOF NV - Meetkerke",
"yourreference": "",
"completed": true
}
,
…
]
}
/Todos/{id}
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: DjGfWxfjrmzSfODPkfzRqIVlfjGVkGmGfjPkztbGfAkIbVOGPt
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 2,
"nr": 2,
"list": "Installatie",
"date_created": "2012–03–12",
"date_expiry": "2012–03–19",
"title": "Installatie",
"concerning": "Afwerken van plinten",
"greeting": "Groeten.",
"greeting_localized": "Regards",
"salutation": "",
"salutation_localized": "",
"sender": "Lutters Carl",
"function": "Bestuurder",
"function_localized": "Director",
"company_id": 1,
"company_name": "Bouwsoft",
"address_id": 34,
"address_name": "A. OTTE EN ZOON",
"address_address": "HAVENWEG 20",
"address_addressline2": "",
"address_countrycode": "",
"address_zipcode": "",
"address_city": "",
"address_telephone1": "+32 3 101 14 11 ",
"address_email": "",
"address_vatnr": "NL 813209791B01",
"contact_id": 0,
"contact_name": 0,
"project_id": 3,
"project_pnr": 20120003,
"project_unr": 3,
"project_name": "Project: Parketvloeren",
"yourreference": "",
"completed": true
}
]
}
/Todos/{id}/conclusion_html
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/conclusion_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
<HTML><BODY>
<DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Montserrat;font-size: 14pt;color: #000000;"> testslotvoor de api</SPAN></DIV>
</BODY></HTML>
/Todos/{id}/conclusion_plain
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/conclusion_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
testslotvoor de api
/Todos/{id}/conclusion_rtf
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/conclusion_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Montserrat;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs28\cf1 testslotvoor de api}
/Todos/{id}/image
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/image
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
image
/Todos/{id}/introduction_html
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/introduction_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
<HTML><BODY>
<DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Arial;font-size: 12pt;color: #000000;">testinleiding voor de api</SPAN></DIV>
</BODY></HTML>
/Todos/{id}/introduction_plain
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/introduction_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
testinleiding voor de api
/Todos/{id}/introduction_rtf
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/introduction_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Arial;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs24\cf1 testinleiding voor de api}
/Todos/{id}/note_html
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/note_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
<HTML><BODY>
<DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Century Gothic;font-size: 10pt;color: #000000;">Afwerken van plinten (api test)</SPAN></DIV>
</BODY></HTML>
/Todos/{id}/note_plain
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbVfWxfOmtzSfIOPlfzRqIVUftbrGfUkftrbzjjjVDUfVkPIUl
Success gives statuscode 200 And the following result
Afwerken van plinten (api test)
/Todos/{id}/note_rtf
If everything succeeds the HTTP response status is 200
(200 OK)
If there is something wrong with the request, the response status and code is 400
(400 Bad Request)
If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)
If you forget to send the Authorization, the response status is 401
(401 Unauthorized)
If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)
For an explanation of all possible errors, please consult our section on possible answers to API calls here
Examples:
https://ra.bouwsoft.be/api/v1/Todos/2/note_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Century Gothic;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs20\cf1 Afwerken van plinten (api test)}