VismaBouwsoftAPICalls.v1_GET_Favorites Method
v1_GET_Favorites() as String

This API call is used to get fields of a(n) Favorite(s)

HTTP method API version
GET v1

Don’t forget to put the Authorization field in the header

API Path: /Favorites/
or
API Path: /Favorites/{id}

You can make this API call:
* without the key field id to get a list of Favorites
* with the key field id as the path parameter (the specific id of the Favorite you want to get)

Fields

The following fields are available:

Field Name Type
id Number
name String
username String
tablename String
windowname String
content String
default Boolean
public Boolean

/Favorites/

API Path: /Favorites/

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

/Favorites/{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/Favorites/11744

with the following parameters :

Header Parameters :
ParameterName: AccessToken, ParameterValue: ftDfWxfbjlzSfmUPAtzRqtlIfUVfIOmDjkktzGbItlIGfPPOGk
ParameterName: Clientnr, ParameterValue: 115

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 11744,
    "name": "test",
    "username": "DIRK",
    "tablename": "test",
    "windowname": "test",
    "content": "{\"columns\":[{\"seqno\":1,\"name\":\"name\",\"print\":true,\"sortnr\":1,\"sortasc\":true},{\"seqno\":2,\"name\":\"description\",\"print\":true}]}",
    "default": false,
    "public": false
  }
]
}