VismaBouwsoftAPICalls.v1_GET_Crews Method
v1_GET_Crews() as String

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

HTTP method API version
GET v1

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

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

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

Fields

The following fields are available:

Field Name Type
id Number
nr String
note String
photo String
description String
crew_list String
crew_group String
employee_id Number
employee_name String
employee_job_id Number
employee_job_name String
responsible Boolean
responsible_id Number

/Crews/

API Path: /Crews/

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

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–24/25”, “Records”: [
  {
    "id": 20,
    "nr": "Equipe 8",
    "note": "",
    "photo": "",
    "description": "Planning",
    "crew_list": "ALGEMEEN",
    "crew_group": "alg alg1",
    "employee_id": 54,
    "employee_name": "Bert MeteenE",
    "employee_job_id": 0,
    "employee_job_name": "",
    "responsible": false,
    "responsible_id": 308
  },
  {
    "id": 50,
    "nr": "Equipe 8",
    "note": "",
    "photo": "",
    "description": "Planning",
    "crew_list": "ALGEMEEN",
    "crew_group": "alg alg1",
    "employee_id": 308,
    "employee_name": "De Prest Brian",
    "employee_job_id": 0,
    "employee_job_name": "",
    "responsible": true,
    "responsible_id": 308
  }
,

]
}

/Crews/{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/Crews/18

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 18,
    "nr": "A7",
    "note": "",
    "photo": "",
    "description": "TeamAndy",
    "crew_list": "ANDY’S TEAMS",
    "crew_group": "",
    "employee_id": 11,
    "employee_name": "Ost Tim",
    "employee_job_id": 0,
    "employee_job_name": "",
    "responsible": true,
    "responsible_id": 11
  }
]
}