logo
API docs by Redocly

Qfact (1.0.0)

Download OpenAPI specification:Download

E-mail: info@qfact.nl URL: https://qfact.nl License: Apache 2.0 Terms of Service

Introduction

De api is benaderbaar via de endpoints https://api.qfact.nl/v1

Project

Endpoints voor Project.

/projects

Haalt alle projecten op op basis van de query parameters

Authorizations:
API key
query Parameters
name
string

Naam van het project

description
string

Beschrijving van het project

status
string

Status van het project

clientId
string

Id van de organisatie die de opdrachtgever is van het project

contractorId
string

Id van de organisatie die de opdrachtnemer is van het project

first
int

Maximum aantal resultaten

skip
int

Aantal resultaten die worden overgeslagen

sort
[string]
Example: sort=name

Sorteren op meegegeven waarde(n). Bij het sorteren op meerder sleutels, gebruik meerdere sort[]={veld}
bijvoorbeeld /projects?sort[]=status&sort[]=name sorteerd eerst op status, en binnen de projecten met gelijke status wordt er op naam gesorteerd.

from
int

Filter voor het tonen van projects die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van projects die events hebben gehad tot deze timestamp. Default waarde is nu als alleen 'from' wordt gebruikt.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/projects

Maak een nieuw project aan met de onderstaande body parameters

Authorizations:
API key
Request Body schema: application/json
name
required
string non-empty

Naam van het project

organisationId
string

(Optional) Het id van de organisatie

clientId
string

(Optional) Id van de opdrachtgever (wanneer het project is aangemaakt door een opdrachtnemer)

contractorId
string

(Optional) Id van de opdrachtgever (wanneer het project is aangemaakt door een opdrachtnemer)

crowType
enum
Enum: "works" "services" "bouwteams"

(Optional) crowType van het project

Responses

Request samples

Content type
application/json
{
  • "name": "Project 1",
  • "organisationId": "1234-6643-8864-2188",
  • "clientId": "1234-6643-8864-2188",
  • "contractorId": "1234-6643-8864-2188",
  • "crowType": "works"
}

Response samples

Content type
application/json
[
  • {
    }
]

/projects/references

Retrieves a paginated list of projects along with their references. Requires a first query parameter to limit the number of records (must be between 1 and 10).

Authorizations:
API key
query Parameters
name
string

Naam van het project

status
string

Status van het project

clientId
string

Id van de organisatie die de opdrachtgever is van het project

contractorId
string

Id van de organisatie die de opdrachtnemer is van het project

first
required
int [ 1 .. 10 ]

Maximum aantal resultaten

skip
int

Aantal resultaten die worden overgeslagen

sort
[string]
Example: sort=name

Sorteren op meegegeven waarde(n). Bij het sorteren op meerder sleutels, gebruik meerdere sort[]={veld}
bijvoorbeeld /projects/references?sort[]=status&sort[]=name sorteerd eerst op status, en binnen de projecten met gelijke status wordt er op naam gesorteerd.

from
int

Filter voor het tonen van projects die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van projects die events hebben gehad tot deze timestamp. Default waarde is nu als alleen 'from' wordt gebruikt.

labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/projects/{id}/references

Haalt het project met dit id op

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

query Parameters
labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321",
  • "name": "Project 1",
  • "description": "Project voor de A12",
  • "status": "active",
  • "organisationId": "1234-5678-7654-4321",
  • "norm": "crow",
  • "createdDate": "16789994",
  • "finishedDate": "16789994",
  • "references": {
    },
  • "contractor": {
    },
  • "client": {
    },
  • "members": [
    ]
}

/projects/{id}

Haalt het project met dit id op

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Responses

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321",
  • "name": "Project 1",
  • "description": "Project voor de A12",
  • "status": "active",
  • "organisationId": "1234-5678-7654-4321",
  • "formIds": [
    ],
  • "settings": null,
  • "norm": "crow",
  • "createdDate": "16789994",
  • "finishedDate": "16789994",
  • "contractor": {
    },
  • "client": {
    },
  • "members": [
    ]
}

/projects/{id}

Verwijder een project met dit id

Authorizations:
API key
path Parameters
id
required
string

Het ID van het te verwijderen project

Responses

/projects/{id}/contractor

Pas de contractor aan voor het project met dit id

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Request Body schema: application/json
contractorId
string non-empty

Contractor (id) van het project

Responses

Request samples

Content type
application/json
{
  • "contractorId": "1234-6643-8864-2188"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321"
}

/projects/{id}/contractor

Oude route om de contractor aan te passen voor het project met bijbehorende id Deze route is depricated, gebruik PATCH /projects/{id}/contractor

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Request Body schema: application/json
contractorId
string non-empty

Contractor (id) van het project

Responses

Request samples

Content type
application/json
{
  • "contractorId": "1234-6643-8864-2188"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321"
}

/projects/{id}/client

Pas de client aan voor het project met dit id

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Request Body schema: application/json
clientId
string non-empty

Client (id) van het project

Responses

Request samples

Content type
application/json
{
  • "clientId": "1234-6643-8864-2188"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321"
}

/projects/{id}/client

Oude route om de client aan voor het project met bijbehorende id aan te passen Deze route is depricated, gebruik PATCH /projects/{id}/client

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Request Body schema: application/json
clientId
string non-empty

Client (id) van het project

Responses

Request samples

Content type
application/json
{
  • "clientId": "1234-6643-8864-2188"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321"
}

/projects/{id}/crowtype

Pas het CrowType aan voor het project met dit id

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Request Body schema: application/json
crowType
enum non-empty

crowType van het project

Responses

Request samples

Content type
application/json
{
  • "crowType": "works"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321"
}

/projects/{id}/crowtype

Oude route om het CrowType aan te passen voor het project met bijbehorende id Deze route is depricated, gebruik PATCH /projects/{id}/crowType

Authorizations:
API key
path Parameters
id
required
string

Het id van het project

Request Body schema: application/json
crowType
enum non-empty

crowType van het project

Responses

Request samples

Content type
application/json
{
  • "crowType": "works"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-4321"
}

Form

Endpoints for Form.

/forms

Haalt alle formulieren op basis van de query parameters op

Authorizations:
API key
query Parameters
name
int

Geeft alle formulieren die deze waarde in hun naam bevatten

projectId
string

Geeft alle formulieren onder hetzelfde project

status
string

Geeft alle formulieren die deze waarde in hun status bevatten

description
string

Geeft alle formulieren met een soortgelijke beschrijving

clientId
string

Geeft alle formulieren met dit id als clientId

contractorId
string

Geeft alle formulieren met dit id als contractorId

first
int

Geeft alle formulieren tot deze positie

skip
int

Geeft alle formulieren vanaf deze positie

sort
[String]

Sorteert forms op meegegeven eigenschap

from
int

Filter voor het tonen van forms die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van forms die events hebben gehad tot deze timestamp. Default waarde van nu als alleen 'from' wordt gebruikt.

formType
enum
Enum: "survey" "bp-intermediate" "bp-final"

Mogelijke waarden: 'bp-intermediate' voor tussentijdse Beter Performance metingen, 'bp-final' voor Better Performance eind metingen or 'survey' voor enquêtes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/forms

Maakt een formulier aan op basis van de body parameters

Authorizations:
API key
Request Body schema: application/json
name
required
string non-empty

Naam van het formulier

projectId
required
string non-empty

Het id van het project waar dit formulier bij hoort

templateId
required
string non-empty

Het id van de template

organisationId
string non-empty

Het id van de organisatie

Responses

Request samples

Content type
application/json
{
  • "name": "Formulier 1",
  • "projectId": "1234-6643-8864-2188",
  • "templateId": "1234-6643-8864-2188",
  • "organisationId": "1234-6643-8864-2188"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-3210",
  • "name": "System",
  • "status": "open"
}

/forms/responses

Retrieves a paginated list of forms along with their responses for the authenticated organisation. Requires a first query parameter to limit the number of records (must be between 1 and 10).

Authorizations:
API key
query Parameters
name
string

Geeft alle formulieren die deze waarde in hun naam bevatten

projectId
string

Geeft alle formulieren onder hetzelfde project

status
string

Geeft alle formulieren die deze waarde in hun status bevatten

clientId
string

Geeft alle formulieren met dit id als clientId

contractorId
string

Geeft alle formulieren met dit id als contractorId

first
required
int [ 1 .. 10 ]

Geeft alle formulieren tot deze positie

skip
int

Geeft alle formulieren vanaf deze positie

sort
[String]

Sorteert forms op meegegeven eigenschap

from
int

Filter voor het tonen van forms die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van forms die events hebben gehad tot deze timestamp. Default waarde van nu als alleen 'from' wordt gebruikt.

formType
enum
Enum: "survey" "bp-intermediate" "bp-final"

Mogelijke waarden: 'bp-intermediate' voor tussentijdse Beter Performance metingen, 'bp-final' voor Better Performance eind metingen or 'survey' voor enquêtes

labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/forms/{id}

Haalt het formulier met dit id op

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

query Parameters
labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-3210",
  • "name": "System",
  • "description": "Formulier van heijmans",
  • "projectId": "1234-5678-7654-3210",
  • "status": "open",
  • "createdDate": "16789994",
  • "finishedDate": "16789994",
  • "project": {
    },
  • "type": "form",
  • "templateId": "1234-5678-7654-3210",
  • "organisationId": "1234-5678-7654-3210",
  • "companionIds": [
    ],
  • "disabledComponents": [
    ],
  • "settings": {
    },
  • "score": 8,
  • "clientScore": 8.7,
  • "clientLabelAverages": [
    ],
  • "clientIndicatorAverages": [
    ],
  • "contractorScore": 9.2,
  • "contractorLabelAverages": [
    ],
  • "contractorIndicatorAverages": [
    ],
  • "formType": "survey",
  • "responses": [
    ]
}

/forms/{id}

Bewerkt het formulier met dit id

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

Request Body schema: application/json
name
string non-empty

De naam van het formulier

description
string

De beschrijving van het formulier

Responses

Request samples

Content type
application/json
{
  • "name": "Formulier 1",
  • "description": "Formulier van heijmans"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-3210",
  • "name": "System",
  • "status": "open"
}

/forms/{id}

Oude route om een formulier met het bijbehorende id te bewerken. Deze route is depricated, gebruik PATCH /forms/{id}

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

Request Body schema: application/json
name
string non-empty

De naam van het formulier

description
string

De beschrijving van het formulier

Responses

Request samples

Content type
application/json
{
  • "name": "Formulier 1",
  • "description": "Formulier van heijmans"
}

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-3210",
  • "name": "System",
  • "status": "open"
}

/forms/{id}

Verwijdert het formulier met dit id

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

Responses

/forms/{id}/responses

Haalt de responses van het formulier met dit id op

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

query Parameters
labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
{
  • "form": {
    },
  • "clientScore": 8.7,
  • "clientLabelAverages": [
    ],
  • "clientIndicatorAverages": [
    ],
  • "contractorScore": 9.2,
  • "contractorLabelAverages": [
    ],
  • "contractorIndicatorAverages": [
    ]
}

/forms/{id}/responses2

Haalt de responses van het formulier met bijbehorende id op

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

Responses

Response samples

Content type
application/json
{
  • "form": {
    },
  • "clientScore": 8.7,
  • "clientLabelAverages": [
    ],
  • "clientIndicatorAverages": [
    ],
  • "contractorScore": 9.2,
  • "contractorLabelAverages": [
    ],
  • "contractorIndicatorAverages": [
    ]
}

FormTemplates

Endpoints voor formTemplates.

/formtemplates{params}

Haalt alle formTemplates op op basis van de query parameters

Authorizations:
API key
query Parameters
first
int

aantal resultaten die je terug krijgt vanaf het eerste resultaat.

skip
int

aantal resultaten overslaan vanaf het eerste resultaat.

sort
Array of arrays

sorteer de resultaten op één of meerdere trefwoorden.

name
string

krijg resultaten die overeen komen met de 'name'.

type
string

krijg resultaten die overeen komen met de 'type'.

answerType
string

krijg resultaten die overeen komen met de 'answerType'.

status
string

krijg resultaten die overeen komen met de 'answerType'.

from
int

Filter voor het tonen van formtemplates die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van formtemplates die events hebben gehad tot deze timestamp. Default waarde is nu als alleen 'from' wordt gebruikt.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/formtemplates/{id}

Haalt de formTemplate op met id

Authorizations:
API key
path Parameters
id
required
string

Het ID van de formTemplates

Responses

Response samples

Content type
application/json
{
  • "id": "5452ba50-1edd-4bf9-9470-ba806bdd2bf8",
  • "type": "form",
  • "name": "Works_contractor_form_template",
  • "answerType": "single_value",
  • "status": "active",
  • "settings": { },
  • "target": "contractor",
  • "componentIds": [
    ],
  • "organisationId": "1234-5678-7654-4321",
  • "masterId": "1234-5678-7654-3210",
  • "companionIds": [
    ],
  • "components": [
    ]
}

Indicator

Endpoints voor Indicator.

/indicators{params}

Haalt alle Indicators op op basis van de query parameters

Authorizations:
API key
query Parameters
first
int

aantal resultaten die je terug krijgt vanaf het eerste resultaat.

skip
int

aantal resultaten overslaan vanaf het eerste resultaat.

sort
Array of arrays

sorteer de resultaten op één of meerdere trefwoorden.

name
string

krijg resultaten die overeen komen met de 'name'.

status
string

krijg resultaten die overeen komen met de 'status'.

description
string

krijg resultaten die overeen komen met de 'description'.

answerType
string

krijg resultaten die overeen komen met de 'answerType'.

from
int

Filter voor het tonen van indicators die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van indicators die events hebben gehad tot deze timestamp. Default waarde is nu als alleen 'from' wordt gebruikt.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/Indicators/{id}

Haalt de Indicator op met id

Authorizations:
API key
path Parameters
id
required
string

Het ID van de Indicator

Responses

Response samples

Content type
application/json
{
  • "id": "1234-5678-7654-3210",
  • "name": "Een voorbeeld vraag",
  • "description": "Een voorbeeld omschrijving",
  • "type": "question",
  • "answerType": "radio",
  • "status": "active",
  • "required": true,
  • "answerValues": [
    ],
  • "labels": [
    ],
  • "setting": { },
  • "context": {
    },
  • "options": null,
  • "organisationId": "1234-5678-7654-4321"
}

Organisation

Endpoints voor Organisations

/organisations{params}

Haalt gegevens van de organisaties op met de opgegeven parameters

Authorizations:
API key
query Parameters
first
int

aantal resultaten die je terug krijgt vanaf het eerste resultaat.

skip
int

aantal resultaten overslaan vanaf het eerste resultaat.

sort
Array of arrays

sorteer de resultaten op één of meerdere trefwoorden.

name
string

krijg resultaten die overeen komen met de 'name'.

status
string

krijg resultaten die overeen komen met de 'type'.

from
int

Filter voor het tonen van organisations die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van organisations die events hebben gehad tot deze timestamp. Default waarde is nu als alleen 'from' wordt gebruikt.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/organisations/{id}

Haalt gegevens van de organisatie met het meegegeven id op

Authorizations:
API key
path Parameters
id
required
string

Het ID van de organisatie

Responses

Response samples

Content type
application/json
{
  • "id": "1234-5678-1234-5678",
  • "name": "Gemeente Amsterdam",
  • "status": "active",
  • "address": {
    },
  • "legal": {
    },
  • "users": [
    ],
  • "products": [
    ],
  • "parent": {
    },
  • "childs": [
    ]
}

Responses

Endpoints voor Responses.

/responses

Haalt alle antwoorden op basis van de queryparameters op.

Authorizations:
API key
query Parameters
formId
string

Id van het bijbehorende Formulier

first
int

Maximum aantal resultaten

skip
int

Aantal resultaten die worden overgeslagen

sort
any

Volgorde van de query

labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/responses/{id}

Haalt de responses van het antwoorden met dit id op

Authorizations:
API key
path Parameters
id
required
string

Het ID van het formulier

query Parameters
labelNames
string

Filter op labelNamen als door komma's gescheiden. e.g labelone,labeltwo

indicatorIds
string

Filter op indicator-ID's als door komma's gescheiden. e.g 1234-5678-7654-3210,1234-5678-7654-3211

Responses

Response samples

Content type
application/json
{
  • "id": "1254-5784-9432-6873",
  • "formId": "1254-5784-9432-6873",
  • "respondentName": "user",
  • "respondentEmail": "user@qfact.nl",
  • "respondentFunction": "Manager",
  • "timestamp": 1748017685342,
  • "values": [
    ]
}

User

Endpoints voor User.

/users{params}

Haalt alle users op op basis van de query parameters

Authorizations:
API key
query Parameters
where
json

Condities van de query

first
int

Aantal resultaten die worden overgeslagen

sort
String

sorteer de resultaten op één of meerdere trefwoorden

skip
int

aantal resultaten overslaan vanaf het eerste resultaat

status
int

een beschrijving

email
int

een beschrijving

roleId
int

een beschrijving

from
int

Filter voor het tonen van users die events hebben gehad vanaf deze timestamp. Default waarde is 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van users die events hebben gehad tot deze timestamp. Default waarde is 'nu' als alleen 'from' wordt gebruikt.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/users/{id}

Haalt de user op met id

Authorizations:
API key
path Parameters
id
required
string

Het ID van de user

Responses

Response samples

Content type
application/json
{
  • "firstName": "System",
  • "lastName": "Admin",
  • "phone": 612345678,
  • "email": "system@admin.com",
  • "avatar": "path/to/image",
  • "status": "Actief",
  • "organisations": {
    }
}

Roles

Endpoints voor Roles.

/roles{params}

Haalt alle roles op op basis van de query parameters

Authorizations:
API key
query Parameters
first
int

aantal resultaten die je terug krijgt vanaf het eerste resultaat.

skip
int

aantal resultaten overslaan vanaf het eerste resultaat.

sort
Array of arrays

sorteer de resultaten op één of meerdere trefwoorden.

from
int

Filter voor het tonen van formtemplates die events hebben gehad vanaf deze timestamp. Default waarde van 0 als alleen 'to' wordt gebruikt.

to
int

Filter voor het tonen van roles die events hebben gehad tot deze timestamp. Default waarde is nu als alleen 'from' wordt gebruikt.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/roles/{id}

Haalt de role op met id

Authorizations:
API key
path Parameters
id
required
string

Het ID van de Indicator

Responses

Response samples

Content type
application/json
{
  • "id": "ccf63470-bf11-443f-9672-86b31a5a1d90",
  • "organisationId": "124263470-bf11-443f-9672-86b31a5afs09",
  • "name": "Admin",
  • "status": "active",
  • "permissions": {
    }
}