API docs by Redocly

VDAB catalog portal API docs (0.1.0)

Download OpenAPI specification:

OpenAPI 3.1.0 documentation for the VDAB Catalog portal API.

Organisations

Organisations related endpoints

List all organisational units

Authorizations:
Bearer
query Parameters
cursor
string

The cursor used to fetch the next result set.

per_page
integer [ 1 .. 100 ]
Default: 25
Example: per_page=10

The number of results to retrieve for this page.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "records": [
    ]
}

Create a new organisationalUnit

Authorizations:
Bearer
Request Body schema: application/json
required
name
required
string

The name of the organisation

id
required
string

Unique identifier of the organisational unit as in the source system

organisation_id
required
string

Reference to the organisation this organisational unit belongs to.

is_headquarters
required
boolean

Whether this organisational unit is the headquarters of the organisation.

business_id
required
string

Business identifier for the organisational unit (e.g., IKP for partners or OE for VDAB).

address
required
string or null

The street address of the organisational unit.

house_number
required
string or null

The house number of the organisational unit.

postal_code
required
string or null

The postal code of the organisational unit.

municipality
required
string or null

The municipality of the organisational unit.

country
required
string or null

The country of the organisational unit.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "organisation_id": "string",
  • "is_headquarters": true,
  • "business_id": "string",
  • "address": "string",
  • "house_number": "string",
  • "postal_code": "string",
  • "municipality": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "organisation_id": "string",
  • "is_headquarters": true,
  • "business_id": "string",
  • "address": "string",
  • "house_number": "string",
  • "postal_code": "string",
  • "municipality": "string",
  • "country": "string"
}

Get an organisational unit by ID

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "organisation_id": "string",
  • "is_headquarters": true,
  • "business_id": "string",
  • "address": "string",
  • "house_number": "string",
  • "postal_code": "string",
  • "municipality": "string",
  • "country": "string"
}

Update an organisational unit by ID

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Request Body schema: application/json
required
name
string
is_headquarters
boolean
business_id
string
address
string or null
house_number
string or null
postal_code
string or null
municipality
string or null
country
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_headquarters": true,
  • "business_id": "string",
  • "address": "string",
  • "house_number": "string",
  • "postal_code": "string",
  • "municipality": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "organisation_id": "string",
  • "is_headquarters": true,
  • "business_id": "string",
  • "address": "string",
  • "house_number": "string",
  • "postal_code": "string",
  • "municipality": "string",
  • "country": "string"
}

Delete an organisational unit by ID,

This will delete the organisational unit from the IAM scope. This means that users linked to this organisational unit will no longer be able to access the application. The OUs are disabled (visible on old content, but no longer selectable for new content) in the Catalog scope to ensure continuity of the Catalog content. Removing the OU from the catalog requires extra user actions, like reconciling otherwise invalid content.

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "key": "string",
  • "errors": [
    ]
}

List all organisations

Authorizations:
Bearer
query Parameters
cursor
string

The cursor used to fetch the next result set.

per_page
integer [ 1 .. 100 ]
Default: 25
Example: per_page=10

The number of results to retrieve for this page.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "records": [
    ]
}

Create a new organisation

Authorizations:
Bearer
Request Body schema: application/json
required
name
required
string

The name of the organisation

id
required
string

Unique identifier of the organisation as in the source system

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

Get an organisation

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

Update an existing organisation

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Request Body schema: application/json
required
name
string

The new name of the organisation

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

Locations

List all locations

Authorizations:
Bearer
query Parameters
cursor
string

The cursor used to fetch the next result set.

per_page
integer [ 1 .. 100 ]
Default: 25
Example: per_page=10

The number of results to retrieve for this page.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "records": [
    ]
}

Create a new location

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string

Unique identifier of the location as in the source system (Locatie Master)

organisational_unit_id
required
string

Unique identifier of the organisational unit to which the location belongs, as provided in the organisational units API

name
required
string

The name of the location. MUST be unique scoped on organisational unit.

address_street_name
required
string

The street name of the location

address_house_number
required
string

The house number of the location, can include extensions like '1A'

address_postal_code
required
string

The postal code of the location

address_city
required
string

The city of the location

address_country
required
string

The country of the location

regions
required
Array of strings

The list of region codes of the location

active
required
boolean

Indicates whether the location is active or not. Inactive locations can no longer be selected on new objects in the GUI.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "organisational_unit_id": "string",
  • "name": "VDAB Employment Center Mechelen",
  • "address_street_name": "Stationsstraat",
  • "address_house_number": "51",
  • "address_postal_code": "2800",
  • "address_city": "Mechelen",
  • "address_country": "Belgium",
  • "regions": [
    ],
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organisational_unit_id": "string",
  • "name": "VDAB Employment Center Mechelen",
  • "address_street_name": "Stationsstraat",
  • "address_house_number": "51",
  • "address_postal_code": "2800",
  • "address_city": "Mechelen",
  • "address_country": "Belgium",
  • "regions": [
    ],
  • "active": true
}

Get a location by ID

Retrieve a specific location by its unique identifier. The ID corresponds to the unique identifier of the location in the source system (Locatie Master).

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organisational_unit_id": "string",
  • "name": "VDAB Employment Center Mechelen",
  • "address_street_name": "Stationsstraat",
  • "address_house_number": "51",
  • "address_postal_code": "2800",
  • "address_city": "Mechelen",
  • "address_country": "Belgium",
  • "regions": [
    ],
  • "active": true
}

Update a location by ID

Update the details of a specific location identified by its unique ID. The ID corresponds to the unique identifier of the location in the source system (Locatie Master).

Authorizations:
Bearer
path Parameters
id
required
string
Example: 17f1e024-df2a-4ac6-b4ac-647d914f7443

The unique identifier of the resource.

Request Body schema: application/json
required
organisational_unit_id
string

Unique identifier of the organisational unit to which the location belongs, as provided in the organisational units API

name
string

The name of the location

address_street_name
string

The street name of the location

address_house_number
string

The house number of the location, can include extensions like '1A'

address_postal_code
string

The postal code of the location

address_city
string

The city of the location

address_country
string

The country of the location

regions
Array of strings

The list of region codes of the location

active
boolean

Indicates whether the location is active or not. Inactive locations can no longer be selected on new objects in the GUI.

Responses

Request samples

Content type
application/json
{
  • "organisational_unit_id": "string",
  • "name": "VDAB Employment Center Mechelen",
  • "address_street_name": "Stationsstraat",
  • "address_house_number": "51",
  • "address_postal_code": "2800",
  • "address_city": "Mechelen",
  • "address_country": "Belgium",
  • "regions": [
    ],
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organisational_unit_id": "string",
  • "name": "VDAB Employment Center Mechelen",
  • "address_street_name": "Stationsstraat",
  • "address_house_number": "51",
  • "address_postal_code": "2800",
  • "address_city": "Mechelen",
  • "address_country": "Belgium",
  • "regions": [
    ],
  • "active": true
}