VismaBouwsoftAPICalls.v1_GET_WorkCodes

Method

v1_GET_WorkCodes() as String

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

HTTP method	API version
GET	v1

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

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

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

Fields

The following fields are available:

Field Name	Type
id	Number
workcode	String
worktext	String
worked	Boolean
actualcostitem_id	Number
absence_actualcostitem_name	String
vacation	Boolean
paid	Boolean

/WorkCodes/

API Path: /WorkCodes/

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/WorkCodes

with the following parameters :

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

Query Parameters :
ParameterName: limit, ParameterValue: 5

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/19”, “Records”: [
  {
    "id": 1,
    "workcode": "01",
    "worktext": "Gepresteerde dagen",
    "worked": true,
    "actualcostitem_id": 0,
    "absence_actualcostitem_name": "",
    "vacation": false,
    "paid": true
  },
  {
    "id": 2,
    "workcode": "AO",
    "worktext": "AO",
    "worked": false,
    "actualcostitem_id": 0,
    "absence_actualcostitem_name": "",
    "vacation": false,
    "paid": true
  }
,
…
]
}

/WorkCodes/{id}