| VismaBouwsoftAPICalls.v1_GET_PhotoSheetDetails | Method |
This API call is used to get fields of a(n) PhotoSheetDetail(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /PhotoSheetDetails/
or
API Path: /PhotoSheetDetails/{id}
or
API Path: /PhotoSheetDetails/{id}/image
or
API Path: /PhotoSheetDetails/{id}/note_html
or
API Path: /PhotoSheetDetails/{id}/note_plain
or
API Path: /PhotoSheetDetails/{id}/note_rtf
You can make this API call:
* without the key field id to get a list of PhotoSheetDetails
* with the key field id as the path parameter (the specific id of the PhotoSheetDetail you want to get)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| parent_id | Number |
| title | String |
| line_nr | String |
| has_note | Boolean |
| has_image | Boolean |
| order | Number |
/PhotoSheetDetails/
API Path: /PhotoSheetDetails/
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/PhotoSheetDetails
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: krjfWxfGfIzSfmltIfzRqjOUfGAUGfArftlbzUGGOllfAPjOGD
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/290”,
“Records”:
[
{
"id": 2,
"parent_id": 4,
"title": "",
"line_nr": "1",
"has_note": true,
"has_image": true,
"order": 1
},
{
"id": 5,
"parent_id": 13,
"title": "",
"line_nr": "1",
"has_note": true,
"has_image": true,
"order": 1
}
,
…
]
}
https://ra.bouwsoft.be/api/v1/PhotoSheetDetails
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: krjfWxfGfIzSfmltIfzRqjOUfGAUGfArftlbzUGGOllfAPjOGD
Query Parameters :
ParameterName: filter, ParameterValue: parent_id eq 243
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 287,
"parent_id": 243,
"title": "",
"line_nr": "",
"has_note": true,
"has_image": true,
"order": 1
}
]
}
/PhotoSheetDetails/{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/PhotoSheetDetails/287
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: krjfWxfGfIzSfmltIfzRqjOUfGAUGfArftlbzUGGOllfAPjOGD
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 287,
"parent_id": 243,
"title": "",
"line_nr": "",
"has_note": true,
"has_image": true,
"order": 1
}
]
}
/PhotoSheetDetails/{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/PhotoSheetDetails/287/image
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: krjfWxfGfIzSfmltIfzRqjOUfGAUGfArftlbzUGGOllfAPjOGD
Success gives statuscode 200 And the following result
image
/PhotoSheetDetails/{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/PhotoSheetDetails/287/note_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: krjfWxfGfIzSfmltIfzRqjOUfGAUGfArftlbzUGGOllfAPjOGD
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;"> testdata voor de api</SPAN></DIV>
</BODY></HTML>
/PhotoSheetDetails/{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/PhotoSheetDetails/287/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: krjfWxfGfIzSfmltIfzRqjOUfGAUGfArftlbzUGGOllfAPjOGD
Success gives statuscode 200 And the following result
testdata voor de api
/PhotoSheetDetails/{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/PhotoSheetDetails/287/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 Montserrat;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs28\cf1 testdata voor de api}